From 00dfbdca0ad10de4b55394279fcbd4a20d42a56a Mon Sep 17 00:00:00 2001 From: Eric Kharitonashvili <33439489+ekhar@users.noreply.github.com> Date: Fri, 28 Feb 2025 10:43:58 -0500 Subject: [PATCH 01/50] Fix Wasm Edge Function Docs (#33910) * fixed docs bug: when importing wasm, you need to include the js and use this. Otherwise, there will be wasm instantiate errors * Update wasm.mdx Got rid of filename on top of markdown * Update index.ts got rid of filename comment at the top --- apps/docs/content/guides/functions/wasm.mdx | 2 +- .../supabase/functions/wasm-modules/index.ts | 9 +-------- 2 files changed, 2 insertions(+), 9 deletions(-) diff --git a/apps/docs/content/guides/functions/wasm.mdx b/apps/docs/content/guides/functions/wasm.mdx index b1c26e34de2..024d585b210 100644 --- a/apps/docs/content/guides/functions/wasm.mdx +++ b/apps/docs/content/guides/functions/wasm.mdx @@ -77,7 +77,7 @@ Before deploying the Edge Function, we need to ensure it bundles the Wasm module ```toml [functions.wasm-add] -static_files = [ "./functions/wasm-add/add-wasm/pkg/*.wasm"] +static_files = [ "./functions/wasm-add/add-wasm/pkg/*"] ``` Deploy the function by running: diff --git a/examples/edge-functions/supabase/functions/wasm-modules/index.ts b/examples/edge-functions/supabase/functions/wasm-modules/index.ts index 66d5085cf24..12774ae77f8 100644 --- a/examples/edge-functions/supabase/functions/wasm-modules/index.ts +++ b/examples/edge-functions/supabase/functions/wasm-modules/index.ts @@ -1,11 +1,4 @@ -const wasmBuffer = await Deno.readFile( - new URL("./add-wasm/pkg/add_wasm_bg.wasm", import.meta.url), -); - -const { instance } = await WebAssembly.instantiate( - wasmBuffer, -); -const { add } = instance.exports; +import { add } from "./add-wasm/pkg/add_wasm.js"; Deno.serve(async (req) => { const { a, b } = await req.json(); From 484805c8788158c36fa47c0a17a0a488454a795b Mon Sep 17 00:00:00 2001 From: Pidanou Eang <32439606+pidanou@users.noreply.github.com> Date: Sat, 1 Mar 2025 01:47:09 +0100 Subject: [PATCH 02/50] docs: edit self-host guide (#32695) - Added information to make the studio work outside of localhost. This information is only given inside .env.example --- apps/docs/content/guides/self-hosting/docker.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/apps/docs/content/guides/self-hosting/docker.mdx b/apps/docs/content/guides/self-hosting/docker.mdx index a0971072e55..e945fffb87c 100644 --- a/apps/docs/content/guides/self-hosting/docker.mdx +++ b/apps/docs/content/guides/self-hosting/docker.mdx @@ -210,6 +210,9 @@ basicauth_credentials: password: password_two ``` +To enable all dashboard features outside of `localhost`, update the following value in the `./docker/.env` file: + - `SUPABASE_PUBLIC_URL`: The URL or IP used to access the dashboard + You will need to [restart](#restarting-all-services) the services for the changes to take effect. ## Restarting all services From 3478fb600d20585f3d4697fd9d38d6d55d3d234d Mon Sep 17 00:00:00 2001 From: Joshen Lim Date: Mon, 3 Mar 2025 14:45:06 +0800 Subject: [PATCH 03/50] Bump configcat refresh rate (#33954) --- apps/studio/lib/configcat.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/studio/lib/configcat.ts b/apps/studio/lib/configcat.ts index 48d173a81bc..0f3c2044d20 100644 --- a/apps/studio/lib/configcat.ts +++ b/apps/studio/lib/configcat.ts @@ -10,7 +10,7 @@ function getClient() { client = configcat.getClient( process.env.NEXT_PUBLIC_CONFIGCAT_SDK_KEY ?? '', configcat.PollingMode.AutoPoll, - { pollIntervalSeconds: 300 } + { pollIntervalSeconds: 7 * 60 } // 7 minutes ) return client From 3d766bc1c110128669eddca6fc092a4f8a228c1a Mon Sep 17 00:00:00 2001 From: Alaister Young Date: Mon, 3 Mar 2025 18:50:09 +1100 Subject: [PATCH 04/50] [FE-1426] feat(studio): clerk fdw (#33803) * feat(studio): clerk fdw * prettier * docs: add Clerk FDW docs * Smol update --------- Co-authored-by: Bo Lu Co-authored-by: Joshen Lim --- .../extensions/wrappers/[[...slug]]/page.tsx | 7 + .../NavigationMenu.constants.ts | 4 + .../Extensions/EnableExtensionModal.tsx | 6 +- .../Integrations/Wrappers/OverviewTab.tsx | 4 +- .../Wrappers/Wrappers.constants.ts | 341 ++++++++++++++++++ 5 files changed, 358 insertions(+), 4 deletions(-) diff --git a/apps/docs/app/guides/database/extensions/wrappers/[[...slug]]/page.tsx b/apps/docs/app/guides/database/extensions/wrappers/[[...slug]]/page.tsx index 883cb4224e4..76c8c71bf48 100644 --- a/apps/docs/app/guides/database/extensions/wrappers/[[...slug]]/page.tsx +++ b/apps/docs/app/guides/database/extensions/wrappers/[[...slug]]/page.tsx @@ -50,6 +50,13 @@ const pageMap = [ }, remoteFile: 'bigquery.md', }, + { + slug: 'clerk', + meta: { + title: 'Clerk', + }, + remoteFile: 'clerk.md', + }, { slug: 'clickhouse', meta: { diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index 5f84fdb6c4b..bfc1249afdc 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -1091,6 +1091,10 @@ export const database: NavMenuConstant = { name: 'Connecting to BigQuery', url: '/guides/database/extensions/wrappers/bigquery', }, + { + name: 'Connecting to Clerk', + url: '/guides/database/extensions/wrappers/clerk', + }, { name: 'Connecting to ClickHouse', url: '/guides/database/extensions/wrappers/clickhouse', diff --git a/apps/studio/components/interfaces/Database/Extensions/EnableExtensionModal.tsx b/apps/studio/components/interfaces/Database/Extensions/EnableExtensionModal.tsx index 3acf2500059..014769ea3b3 100644 --- a/apps/studio/components/interfaces/Database/Extensions/EnableExtensionModal.tsx +++ b/apps/studio/components/interfaces/Database/Extensions/EnableExtensionModal.tsx @@ -4,10 +4,12 @@ import { useEffect, useState } from 'react' import { toast } from 'sonner' import { useProjectContext } from 'components/layouts/ProjectLayout/ProjectContext' +import { DocsButton } from 'components/ui/DocsButton' import ShimmeringLoader from 'components/ui/ShimmeringLoader' import { useDatabaseExtensionEnableMutation } from 'data/database-extensions/database-extension-enable-mutation' import { useSchemasQuery } from 'data/database/schemas-query' import { executeSql } from 'data/sql/execute-sql-query' +import { useIsOrioleDb } from 'hooks/misc/useSelectedProject' import { AlertDescription_Shadcn_, AlertTitle_Shadcn_, @@ -20,8 +22,6 @@ import { WarningIcon, } from 'ui' import { Admonition } from 'ui-patterns' -import { DocsButton } from 'components/ui/DocsButton' -import { useIsOrioleDb } from 'hooks/misc/useSelectedProject' const orioleExtCallOuts = ['vector', 'postgis'] @@ -43,7 +43,7 @@ const EnableExtensionModal = ({ visible, extension, onCancel }: EnableExtensionM }) const { mutate: enableExtension, isLoading: isEnabling } = useDatabaseExtensionEnableMutation({ onSuccess: () => { - toast.success(`${extension.name} is on.`) + toast.success(`Extension "${extension.name}" is now enabled`) onCancel() }, onError: (error) => { diff --git a/apps/studio/components/interfaces/Integrations/Wrappers/OverviewTab.tsx b/apps/studio/components/interfaces/Integrations/Wrappers/OverviewTab.tsx index 6a0141d0ff5..8408082c045 100644 --- a/apps/studio/components/interfaces/Integrations/Wrappers/OverviewTab.tsx +++ b/apps/studio/components/interfaces/Integrations/Wrappers/OverviewTab.tsx @@ -45,8 +45,10 @@ export const WrapperOverviewTab = () => { const isWrappersExtensionInstalled = !!wrappersExtension?.installed_version const hasRequiredVersion = (wrappersExtension?.installed_version ?? '') >= (wrapperMeta?.minimumExtensionVersion ?? '') + // [Joshen] Default version is what's on the DB, so if the installed version is already the default version + // but still doesnt meet the minimum extension version, then DB upgrade is required const databaseNeedsUpgrading = - wrappersExtension?.installed_version !== wrappersExtension?.default_version + wrappersExtension?.installed_version === wrappersExtension?.default_version return ( Date: Mon, 3 Mar 2025 19:03:10 +1000 Subject: [PATCH 05/50] Link to auth provider (#33951) * link to provider * Simplify implementation --------- Co-authored-by: Joshen Lim --- .../Auth/AuthProvidersForm/ProviderForm.tsx | 25 ++++++++++++++++--- .../PolicyTableRow/PolicyTableRowHeader.tsx | 2 -- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/apps/studio/components/interfaces/Auth/AuthProvidersForm/ProviderForm.tsx b/apps/studio/components/interfaces/Auth/AuthProvidersForm/ProviderForm.tsx index 4149642b55e..e82bc054744 100644 --- a/apps/studio/components/interfaces/Auth/AuthProvidersForm/ProviderForm.tsx +++ b/apps/studio/components/interfaces/Auth/AuthProvidersForm/ProviderForm.tsx @@ -1,6 +1,6 @@ import { PermissionAction } from '@supabase/shared-types/out/constants' import { Check } from 'lucide-react' -import { useState } from 'react' +import { useEffect, useState } from 'react' import ReactMarkdown from 'react-markdown' import { toast } from 'sonner' @@ -15,6 +15,7 @@ import { useProjectSettingsV2Query } from 'data/config/project-settings-v2-query import { useCustomDomainsQuery } from 'data/custom-domains/custom-domains-query' import { useCheckPermissions } from 'hooks/misc/useCheckPermissions' import { BASE_PATH } from 'lib/constants' +import { useQueryState } from 'nuqs' import { Button, Form, Input, Sheet, SheetContent, SheetFooter, SheetHeader, SheetTitle } from 'ui' import { Admonition } from 'ui-patterns' import { NO_REQUIRED_CHARACTERS } from '../Auth.constants' @@ -29,8 +30,10 @@ export interface ProviderFormProps { } export const ProviderForm = ({ config, provider, isActive }: ProviderFormProps) => { + const { ref: projectRef } = useParams() + const [urlProvider, setUrlProvider] = useQueryState('provider', { defaultValue: '' }) + const [open, setOpen] = useState(false) - const { ref: projectRef, provider: urlProvider } = useParams() const { mutate: updateAuthConfig, isLoading: isUpdatingConfig } = useAuthConfigUpdateMutation() const doubleNegativeKeys = ['MAILER_AUTOCONFIRM', 'SMS_AUTOCONFIRM'] @@ -113,10 +116,24 @@ export const ProviderForm = ({ config, provider, isActive }: ProviderFormProps) ) } + // Handle clicking on a provider in the list + const handleProviderClick = () => setUrlProvider(provider.title) + + const handleOpenChange = (isOpen: boolean) => { + // Remove provider query param from URL when closed + if (!isOpen) setUrlProvider(null) + } + + // Open or close the form based on the query parameter + useEffect(() => { + const isProviderInQuery = urlProvider.toLowerCase() === provider.title.toLowerCase() + setOpen(isProviderInQuery) + }, [urlProvider, provider.title]) + return ( <> setOpen(true)} + onClick={handleProviderClick} media={ - + From eca4cc15a2e3431f76ce57d204a02a49ed1d0ffa Mon Sep 17 00:00:00 2001 From: Ivan Vasilov Date: Mon, 3 Mar 2025 12:18:14 +0100 Subject: [PATCH 06/50] chore: Bump vulnerable deps (#33915) * Consolidate different versions of postcss. Remove @mertasan/tailwindcss-variables from ui package. * Bump vitest in pg-meta to remove a vulnerable version of vite. * Bump dompurify. * Bump all octokit deps to solve 2 vulns. * Fix warnings about destructuring json imports. * Remove a console.log in docs. * Fix the changelog page to use an ESM import. * Stabilize the generate-sitemap script output. * Try another fix for the changelog. --- apps/docs/layouts/MainSkeleton.tsx | 6 +- apps/docs/package.json | 6 +- .../www/components/Nav/DevelopersDropdown.tsx | 7 +- apps/www/components/Nav/GitHubButton.tsx | 5 +- apps/www/components/Nav/MobileMenu.tsx | 14 +- apps/www/internals/generate-sitemap.mjs | 4 +- apps/www/next.config.mjs | 29 +- apps/www/package.json | 8 +- apps/www/pages/changelog.tsx | 4 +- apps/www/public/sitemap_www.xml | 1404 +++++++++++++---- packages/pg-meta/package.json | 2 +- packages/ui/package.json | 1 - pnpm-lock.yaml | 958 +++-------- 13 files changed, 1405 insertions(+), 1043 deletions(-) diff --git a/apps/docs/layouts/MainSkeleton.tsx b/apps/docs/layouts/MainSkeleton.tsx index 51cc8e6a168..73ecb7902d3 100644 --- a/apps/docs/layouts/MainSkeleton.tsx +++ b/apps/docs/layouts/MainSkeleton.tsx @@ -6,11 +6,11 @@ import { memo, useEffect, type PropsWithChildren, type ReactNode } from 'react' import { cn } from 'ui' +import { type NavMenuSection } from '~/components/Navigation/Navigation.types' import DefaultNavigationMenu, { MenuId, } from '~/components/Navigation/NavigationMenu/NavigationMenu' import { getMenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu.utils' -import { type NavMenuSection } from '~/components/Navigation/Navigation.types' import TopNavBar from '~/components/Navigation/NavigationMenu/TopNavBar' import { DOCS_CONTENT_CONTAINER_ID } from '~/features/ui/helpers.constants' import { menuState, useMenuMobileOpen } from '~/hooks/useMenuState' @@ -381,8 +381,6 @@ function SidebarSkeleton({ const mobileMenuOpen = useMenuMobileOpen() - console.log('menuName', menuName, menuId) - return (
{!hideSideNav && ( @@ -425,4 +423,4 @@ function SidebarSkeleton({ ) } -export { TopNavSkeleton, SidebarSkeleton } +export { SidebarSkeleton, TopNavSkeleton } diff --git a/apps/docs/package.json b/apps/docs/package.json index d081932a2e4..635b5f06cba 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -38,9 +38,9 @@ "@mdx-js/react": "^2.3.0", "@next/bundle-analyzer": "^14.2.3", "@next/mdx": "^14.2.3", - "@octokit/auth-app": "^6.0.3", - "@octokit/core": "^5.1.0", - "@octokit/graphql": "^7.0.2", + "@octokit/auth-app": "^7.0.0", + "@octokit/core": "^6.0.0", + "@octokit/graphql": "^8.0.0", "@octokit/plugin-paginate-graphql": "^4.0.0", "@radix-ui/react-accordion": "^1.1.2", "@radix-ui/react-collapsible": "^1.0.3", diff --git a/apps/www/components/Nav/DevelopersDropdown.tsx b/apps/www/components/Nav/DevelopersDropdown.tsx index 022725b7522..b01d36e47e1 100644 --- a/apps/www/components/Nav/DevelopersDropdown.tsx +++ b/apps/www/components/Nav/DevelopersDropdown.tsx @@ -2,10 +2,9 @@ import { ChevronRight } from 'lucide-react' import Link from 'next/link' import { data as DevelopersData } from 'data/Developers' -import { - jobsCount, - latestBlogPosts, -} from '~/.contentlayer/generated/staticContent/_index.json' with { type: 'json' } +import staticContent from '~/.contentlayer/generated/staticContent/_index.json' with { type: 'json' } + +const { jobsCount, latestBlogPosts } = staticContent type LinkProps = { text: string diff --git a/apps/www/components/Nav/GitHubButton.tsx b/apps/www/components/Nav/GitHubButton.tsx index 9211dd0ce44..37aa4ab7ad8 100644 --- a/apps/www/components/Nav/GitHubButton.tsx +++ b/apps/www/components/Nav/GitHubButton.tsx @@ -1,8 +1,9 @@ -import React from 'react' import { Button } from 'ui' -import { githubStars } from '~/.contentlayer/generated/staticContent/_index.json' with { type: 'json' } +import staticContent from '~/.contentlayer/generated/staticContent/_index.json' with { type: 'json' } import { useSendTelemetryEvent } from '~/lib/telemetry' +const { githubStars } = staticContent + const GitHubButton = () => { const kFormatter = (num: number) => { const kFormat = Math.floor(num / 1000) diff --git a/apps/www/components/Nav/MobileMenu.tsx b/apps/www/components/Nav/MobileMenu.tsx index c87274771d2..8ed1e8955ab 100644 --- a/apps/www/components/Nav/MobileMenu.tsx +++ b/apps/www/components/Nav/MobileMenu.tsx @@ -1,22 +1,24 @@ -import React, { Dispatch, SetStateAction } from 'react' +import { AnimatePresence, LazyMotion, domAnimation, m } from 'framer-motion' import Image from 'next/image' import Link from 'next/link' -import { m, AnimatePresence, LazyMotion, domAnimation } from 'framer-motion' +import { Dispatch, SetStateAction } from 'react' -import { DEFAULT_EASE } from '~/lib/animations' import { Accordion, Button, TextLink } from 'ui' +import { DEFAULT_EASE } from '~/lib/animations' import MenuItem from './MenuItem' +import { useIsLoggedIn, useIsUserLoading } from 'common' import * as supabaseLogoWordmarkDark from 'common/assets/images/supabase-logo-wordmark--dark.png' import * as supabaseLogoWordmarkLight from 'common/assets/images/supabase-logo-wordmark--light.png' -import { useKey } from 'react-use' -import { useIsLoggedIn, useIsUserLoading } from 'common' import { ChevronRight } from 'lucide-react' +import { useKey } from 'react-use' +import staticContent from '~/.contentlayer/generated/staticContent/_index.json' with { type: 'json' } import ProductModulesData from '~/data/ProductModules' -import { jobsCount } from '~/.contentlayer/generated/staticContent/_index.json' with { type: 'json' } import { useSendTelemetryEvent } from '~/lib/telemetry' +const { jobsCount } = staticContent + interface Props { open: boolean setOpen: Dispatch> diff --git a/apps/www/internals/generate-sitemap.mjs b/apps/www/internals/generate-sitemap.mjs index abe470b5b99..4e3131c8a88 100644 --- a/apps/www/internals/generate-sitemap.mjs +++ b/apps/www/internals/generate-sitemap.mjs @@ -10,7 +10,7 @@ import prettier from 'prettier' async function generate() { const prettierConfig = await prettier.resolveConfig('./.prettierrc.js') - const pages = await globby([ + const unsortedPages = await globby([ 'pages/*.js', 'pages/*.tsx', 'pages/*.mdx', @@ -31,6 +31,8 @@ async function generate() { '.next/server/pages/features/*.html', ]) + const pages = unsortedPages.sort((a, b) => a.localeCompare(b)) + const blogUrl = 'blog' const caseStudiesUrl = 'case-studies' const customerStoriesUrl = 'customers' diff --git a/apps/www/next.config.mjs b/apps/www/next.config.mjs index bf3de651f51..62fa7f28750 100644 --- a/apps/www/next.config.mjs +++ b/apps/www/next.config.mjs @@ -45,7 +45,20 @@ const nextConfig = { assetPrefix: getAssetPrefix(), pageExtensions: ['js', 'jsx', 'ts', 'tsx', 'md', 'mdx'], trailingSlash: false, - transpilePackages: ['ui', 'ui-patterns', 'common', 'shared-data', 'icons', 'api-types'], + transpilePackages: [ + 'ui', + 'ui-patterns', + 'common', + 'shared-data', + 'icons', + 'api-types', + // needed to make the octokit packages work in /changelog + '@octokit/plugin-paginate-graphql', + ], + experimental: { + // needed to make the octokit packages work in /changelog + esmExternals: 'loose', + }, reactStrictMode: true, swcMinify: true, images: { @@ -81,10 +94,16 @@ const nextConfig = { headers: [{ key: 'cache-control', value: 'public, max-age=86400' }], }, { - source: "/(.*)", - headers: [{ - key: 'Strict-Transport-Security', - value: process.env.NEXT_PUBLIC_IS_PLATFORM === 'true' && process.env.VERCEL === '1' ? 'max-age=1200; includeSubDomains' : '' }], + source: '/(.*)', + headers: [ + { + key: 'Strict-Transport-Security', + value: + process.env.NEXT_PUBLIC_IS_PLATFORM === 'true' && process.env.VERCEL === '1' + ? 'max-age=1200; includeSubDomains' + : '', + }, + ], }, ] }, diff --git a/apps/www/package.json b/apps/www/package.json index 3ccc865b5c0..cc019fd9e7b 100644 --- a/apps/www/package.json +++ b/apps/www/package.json @@ -22,11 +22,11 @@ "@mdx-js/react": "^2.3.0", "@next/bundle-analyzer": "^14.2.3", "@next/mdx": "^14.2.3", - "@octokit/auth-app": "^6.0.3", - "@octokit/core": "^5.0.2", - "@octokit/graphql": "^7.0.2", + "@octokit/auth-app": "^7.0.0", + "@octokit/core": "^6.0.0", + "@octokit/graphql": "^8.0.0", "@octokit/plugin-paginate-graphql": "^4.0.0", - "@octokit/rest": "^20.0.2", + "@octokit/rest": "^21.0.0", "@radix-ui/react-dialog": "^1.0.5", "@supabase/supabase-js": "catalog:", "@vercel/og": "^0.6.2", diff --git a/apps/www/pages/changelog.tsx b/apps/www/pages/changelog.tsx index 39b1db04034..cabb9ac13d2 100644 --- a/apps/www/pages/changelog.tsx +++ b/apps/www/pages/changelog.tsx @@ -1,5 +1,6 @@ import { ArrowLeftIcon, ArrowRightIcon } from '@heroicons/react/outline' import { createAppAuth } from '@octokit/auth-app' +import { Octokit } from '@octokit/core' import { paginateGraphql } from '@octokit/plugin-paginate-graphql' import { Octokit as OctokitRest } from '@octokit/rest' import dayjs from 'dayjs' @@ -80,7 +81,7 @@ export const getServerSideProps: GetServerSideProps = async ({ res, query }) => // Process as of Feb. 2024: // create a Release each month and create a corresponding changelog discussion - // — we don't want to pull in both the changelog entry and the release entry + // — we don't want to pull in both the changelog entry and the release entry // — we want to ignore new releases and only show the old ones that don't have a corresponding changelog discussion // — so we have this list of old releases that we want to show const oldReleases = [ @@ -94,7 +95,6 @@ export const getServerSideProps: GetServerSideProps = async ({ res, query }) => // uses the graphql api async function fetchDiscussions(owner: string, repo: string, categoryId: string, cursor: string) { - const { Octokit } = await import('@octokit/core') const ExtendedOctokit = Octokit.plugin(paginateGraphql) type ExtendedOctokit = InstanceType diff --git a/apps/www/public/sitemap_www.xml b/apps/www/public/sitemap_www.xml index 008f56cc3b9..82007bd3a66 100644 --- a/apps/www/public/sitemap_www.xml +++ b/apps/www/public/sitemap_www.xml @@ -1,283 +1,19 @@ - https://supabase.com/assistant + https://supabase.com/alternatives/supabase-vs-auth0 weekly 0.5 - https://supabase.com/aup + https://supabase.com/alternatives/supabase-vs-firebase weekly 0.5 - https://supabase.com/auth - weekly - 0.5 - - - - https://supabase.com/beta - weekly - 0.5 - - - - https://supabase.com/blog - weekly - 0.5 - - - - https://supabase.com/brand-assets - weekly - 0.5 - - - - https://supabase.com/careers - weekly - 0.5 - - - - https://supabase.com/changelog - weekly - 0.5 - - - - https://supabase.com/company - weekly - 0.5 - - - - https://supabase.com/customers - weekly - 0.5 - - - - https://supabase.com/database - weekly - 0.5 - - - - https://supabase.com/edge-functions - weekly - 0.5 - - - - https://supabase.com/enterprise - weekly - 0.5 - - - - https://supabase.com/features - weekly - 0.5 - - - - https://supabase.com/ga-week - weekly - 0.5 - - - - https://supabase.com/ga - weekly - 0.5 - - - - https://supabase.com - weekly - 0.5 - - - - https://supabase.com/nextjs - weekly - 0.5 - - - - https://supabase.com/open-source - weekly - 0.5 - - - - https://supabase.com/pricing - weekly - 0.5 - - - - https://supabase.com/privacy-240804 - weekly - 0.5 - - - - https://supabase.com/privacy - weekly - 0.5 - - - - https://supabase.com/realtime - weekly - 0.5 - - - - https://supabase.com/security - weekly - 0.5 - - - - https://supabase.com/sla - weekly - 0.5 - - - - https://supabase.com/storage - weekly - 0.5 - - - - https://supabase.com/support-policy - weekly - 0.5 - - - - https://supabase.com/support - weekly - 0.5 - - - - https://supabase.com/terms - weekly - 0.5 - - - - https://supabase.com/blog/ - weekly - 0.5 - - - - https://supabase.com/contact/sales - weekly - 0.5 - - - - https://supabase.com/events - weekly - 0.5 - - - - https://supabase.com/legal/dpa - weekly - 0.5 - - - - https://supabase.com/modules/cron - weekly - 0.5 - - - - https://supabase.com/modules/queues - weekly - 0.5 - - - - https://supabase.com/modules/vector - weekly - 0.5 - - - - https://supabase.com/opt-out/[ref] - weekly - 0.5 - - - - https://supabase.com/opt-out - weekly - 0.5 - - - - https://supabase.com/partners - weekly - 0.5 - - - - https://supabase.com/launch-week - weekly - 0.5 - - - - https://supabase.com/blog/ - weekly - 0.5 - - - - https://supabase.com/partners/integrations - weekly - 0.5 - - - - https://supabase.com/launch-week/12 - weekly - 0.5 - - - - https://supabase.com/launch-week/6 - weekly - 0.5 - - - - https://supabase.com/launch-week/7 - weekly - 0.5 - - - - https://supabase.com/launch-week/8 - weekly - 0.5 - - - - https://supabase.com/launch-week/x + https://supabase.com/alternatives/supabase-vs-heroku-postgres weekly 0.5 @@ -2174,6 +1910,36 @@ 0.5 + + https://supabase.com/blog/how-to-hack-the-base + weekly + 0.5 + + + + https://supabase.com/blog/ai-hackathon-at-y-combinator + weekly + 0.5 + + + + https://supabase.com/blog/calendars-in-postgres-using-foreign-data-wrappers + weekly + 0.5 + + + + https://supabase.com/blog/lw13-hackathon-winners + weekly + 0.5 + + + + https://supabase.com/blog/pgrouting-postgres-graph-database + weekly + 0.5 + + https://supabase.com/customers/berriai weekly @@ -2319,19 +2085,1117 @@ - https://supabase.com/alternatives/supabase-vs-auth0 + https://supabase.com/features/ai-assistant weekly 0.5 - https://supabase.com/alternatives/supabase-vs-firebase + https://supabase.com/features/ai-integrations weekly 0.5 - https://supabase.com/alternatives/supabase-vs-heroku-postgres + https://supabase.com/features/auth-captcha-protection + weekly + 0.5 + + + + https://supabase.com/features/auto-generated-graphql-api + weekly + 0.5 + + + + https://supabase.com/features/auto-generated-rest-api + weekly + 0.5 + + + + https://supabase.com/features/branching + weekly + 0.5 + + + + https://supabase.com/features/cdn + weekly + 0.5 + + + + https://supabase.com/features/cli + weekly + 0.5 + + + + https://supabase.com/features/client-library-flutter + weekly + 0.5 + + + + https://supabase.com/features/client-library-javascript + weekly + 0.5 + + + + https://supabase.com/features/client-library-python + weekly + 0.5 + + + + https://supabase.com/features/client-library-swift + weekly + 0.5 + + + + https://supabase.com/features/custom-domains + weekly + 0.5 + + + + https://supabase.com/features/database-backups + weekly + 0.5 + + + + https://supabase.com/features/database-webhooks + weekly + 0.5 + + + + https://supabase.com/features/deno-edge-functions + weekly + 0.5 + + + + https://supabase.com/features/email-login + weekly + 0.5 + + + + https://supabase.com/features/file-storage + weekly + 0.5 + + + + https://supabase.com/features/foreign-key-selector + weekly + 0.5 + + + + https://supabase.com/features/image-transformations + weekly + 0.5 + + + + https://supabase.com/features/log-drains + weekly + 0.5 + + + + https://supabase.com/features/logs-analytics + weekly + 0.5 + + + + https://supabase.com/features/management-api + weekly + 0.5 + + + + https://supabase.com/features/multi-factor-authentication + weekly + 0.5 + + + + https://supabase.com/features/network-restrictions + weekly + 0.5 + + + + https://supabase.com/features/npm-compatibility + weekly + 0.5 + + + + https://supabase.com/features/orioledb + weekly + 0.5 + + + + https://supabase.com/features/passwordless-login-via-magicklink + weekly + 0.5 + + + + https://supabase.com/features/phone-logins + weekly + 0.5 + + + + https://supabase.com/features/policy-templates + weekly + 0.5 + + + + https://supabase.com/features/postgres-database + weekly + 0.5 + + + + https://supabase.com/features/postgres-extensions + weekly + 0.5 + + + + https://supabase.com/features/postgres-roles + weekly + 0.5 + + + + https://supabase.com/features/queues + weekly + 0.5 + + + + https://supabase.com/features/read-replicas + weekly + 0.5 + + + + https://supabase.com/features/realtime-broadcast-authorization + weekly + 0.5 + + + + https://supabase.com/features/realtime-broadcast + weekly + 0.5 + + + + https://supabase.com/features/realtime-postgres-changes + weekly + 0.5 + + + + https://supabase.com/features/realtime-presence-authorization + weekly + 0.5 + + + + https://supabase.com/features/realtime-presence + weekly + 0.5 + + + + https://supabase.com/features/regional-invocations + weekly + 0.5 + + + + https://supabase.com/features/reports-and-metrics + weekly + 0.5 + + + + https://supabase.com/features/resumable-uploads + weekly + 0.5 + + + + https://supabase.com/features/role-based-access-control + weekly + 0.5 + + + + https://supabase.com/features/row-level-security + weekly + 0.5 + + + + https://supabase.com/features/s3-compatibility + weekly + 0.5 + + + + https://supabase.com/features/security-and-performance-advisor + weekly + 0.5 + + + + https://supabase.com/features/server-side-auth + weekly + 0.5 + + + + https://supabase.com/features/smart-cdn + weekly + 0.5 + + + + https://supabase.com/features/soc-2-compliance + weekly + 0.5 + + + + https://supabase.com/features/social-login + weekly + 0.5 + + + + https://supabase.com/features/sql-editor + weekly + 0.5 + + + + https://supabase.com/features/ssl-enforcement + weekly + 0.5 + + + + https://supabase.com/features/supabase-cron + weekly + 0.5 + + + + https://supabase.com/features/supavisor + weekly + 0.5 + + + + https://supabase.com/features/terraform-provider + weekly + 0.5 + + + + https://supabase.com/features/user-impersonation + weekly + 0.5 + + + + https://supabase.com/features/vault + weekly + 0.5 + + + + https://supabase.com/features/vector-database + weekly + 0.5 + + + + https://supabase.com/features/visual-schema-designer + weekly + 0.5 + + + + https://supabase.com/partners/integrations/appsmith + weekly + 0.5 + + + + https://supabase.com/partners/integrations/arengu + weekly + 0.5 + + + + https://supabase.com/partners/integrations/artie + weekly + 0.5 + + + + https://supabase.com/partners/integrations/atomic_crm + weekly + 0.5 + + + + https://supabase.com/partners/integrations/auth0 + weekly + 0.5 + + + + https://supabase.com/partners/integrations/authsignal + weekly + 0.5 + + + + https://supabase.com/partners/integrations/basedash + weekly + 0.5 + + + + https://supabase.com/partners/integrations/bemi + weekly + 0.5 + + + + https://supabase.com/partners/integrations/buster + weekly + 0.5 + + + + https://supabase.com/partners/integrations/clerk + weekly + 0.5 + + + + https://supabase.com/partners/integrations/cloudflare-workers + weekly + 0.5 + + + + https://supabase.com/partners/integrations/clutch + weekly + 0.5 + + + + https://supabase.com/partners/integrations/codesandbox + weekly + 0.5 + + + + https://supabase.com/partners/integrations/corbado + weekly + 0.5 + + + + https://supabase.com/partners/integrations/cyberduck + weekly + 0.5 + + + + https://supabase.com/partners/integrations/deepnote + weekly + 0.5 + + + + https://supabase.com/partners/integrations/dezbor + weekly + 0.5 + + + + https://supabase.com/partners/integrations/dhiwise + weekly + 0.5 + + + + https://supabase.com/partners/integrations/directus + weekly + 0.5 + + + + https://supabase.com/partners/integrations/doppler + weekly + 0.5 + + + + https://supabase.com/partners/integrations/draftbit + weekly + 0.5 + + + + https://supabase.com/partners/integrations/drapcode + weekly + 0.5 + + + + https://supabase.com/partners/integrations/draxlr + weekly + 0.5 + + + + https://supabase.com/partners/integrations/dronahq + weekly + 0.5 + + + + https://supabase.com/partners/integrations/electricsql + weekly + 0.5 + + + + https://supabase.com/partners/integrations/estuary + weekly + 0.5 + + + + https://supabase.com/partners/integrations/explo + weekly + 0.5 + + + + https://supabase.com/partners/integrations/fezto + weekly + 0.5 + + + + https://supabase.com/partners/integrations/flutterflow + weekly + 0.5 + + + + https://supabase.com/partners/integrations/forestadmin + weekly + 0.5 + + + + https://supabase.com/partners/integrations/getstream_io + weekly + 0.5 + + + + https://supabase.com/partners/integrations/illa + weekly + 0.5 + + + + https://supabase.com/partners/integrations/infisical + weekly + 0.5 + + + + https://supabase.com/partners/integrations/insightbase + weekly + 0.5 + + + + https://supabase.com/partners/integrations/internalio + weekly + 0.5 + + + + https://supabase.com/partners/integrations/jetadmin + weekly + 0.5 + + + + https://supabase.com/partners/integrations/keyri + weekly + 0.5 + + + + https://supabase.com/partners/integrations/kinde + weekly + 0.5 + + + + https://supabase.com/partners/integrations/litellm + weekly + 0.5 + + + + https://supabase.com/partners/integrations/loops + weekly + 0.5 + + + + https://supabase.com/partners/integrations/n8n + weekly + 0.5 + + + + https://supabase.com/partners/integrations/nextauth + weekly + 0.5 + + + + https://supabase.com/partners/integrations/nuxt + weekly + 0.5 + + + + https://supabase.com/partners/integrations/onesignal + weekly + 0.5 + + + + https://supabase.com/partners/integrations/ory + weekly + 0.5 + + + + https://supabase.com/partners/integrations/passageidentity + weekly + 0.5 + + + + https://supabase.com/partners/integrations/pgmustard + weekly + 0.5 + + + + https://supabase.com/partners/integrations/plasmic + weekly + 0.5 + + + + https://supabase.com/partners/integrations/powersync + weekly + 0.5 + + + + https://supabase.com/partners/integrations/prisma + weekly + 0.5 + + + + https://supabase.com/partners/integrations/react-admin + weekly + 0.5 + + + + https://supabase.com/partners/integrations/readyset + weekly + 0.5 + + + + https://supabase.com/partners/integrations/refine_dev + weekly + 0.5 + + + + https://supabase.com/partners/integrations/replibyte + weekly + 0.5 + + + + https://supabase.com/partners/integrations/replicache + weekly + 0.5 + + + + https://supabase.com/partners/integrations/resend + weekly + 0.5 + + + + https://supabase.com/partners/integrations/retool + weekly + 0.5 + + + + https://supabase.com/partners/integrations/risingwave + weekly + 0.5 + + + + https://supabase.com/partners/integrations/sequin_io + weekly + 0.5 + + + + https://supabase.com/partners/integrations/stacksync + weekly + 0.5 + + + + https://supabase.com/partners/integrations/stormkit + weekly + 0.5 + + + + https://supabase.com/partners/integrations/streamlit + weekly + 0.5 + + + + https://supabase.com/partners/integrations/stytch + weekly + 0.5 + + + + https://supabase.com/partners/integrations/supabase_wrapper_bigquery + weekly + 0.5 + + + + https://supabase.com/partners/integrations/supabase_wrapper_firebase + weekly + 0.5 + + + + https://supabase.com/partners/integrations/supabase_wrapper_stripe + weekly + 0.5 + + + + https://supabase.com/partners/integrations/supertokens + weekly + 0.5 + + + + https://supabase.com/partners/integrations/tamagui-takeout + weekly + 0.5 + + + + https://supabase.com/partners/integrations/toddle + weekly + 0.5 + + + + https://supabase.com/partners/integrations/trevor_io + weekly + 0.5 + + + + https://supabase.com/partners/integrations/triggerdotdev + weekly + 0.5 + + + + https://supabase.com/partners/integrations/vercel + weekly + 0.5 + + + + https://supabase.com/partners/integrations/voltapp + weekly + 0.5 + + + + https://supabase.com/partners/integrations/weweb + weekly + 0.5 + + + + https://supabase.com/partners/integrations/windmill + weekly + 0.5 + + + + https://supabase.com/partners/integrations/yepcode + weekly + 0.5 + + + + https://supabase.com/partners/integrations/zapier + weekly + 0.5 + + + + https://supabase.com/partners/integrations/zapp_run + weekly + 0.5 + + + + https://supabase.com/partners/integrations/zuplo + weekly + 0.5 + + + + https://supabase.com/assistant + weekly + 0.5 + + + + https://supabase.com/aup + weekly + 0.5 + + + + https://supabase.com/auth + weekly + 0.5 + + + + https://supabase.com/beta + weekly + 0.5 + + + + https://supabase.com/blog + weekly + 0.5 + + + + https://supabase.com/blog/ + weekly + 0.5 + + + + https://supabase.com/blog/ + weekly + 0.5 + + + + https://supabase.com/brand-assets + weekly + 0.5 + + + + https://supabase.com/careers + weekly + 0.5 + + + + https://supabase.com/changelog + weekly + 0.5 + + + + https://supabase.com/company + weekly + 0.5 + + + + https://supabase.com/contact/sales + weekly + 0.5 + + + + https://supabase.com/customers + weekly + 0.5 + + + + https://supabase.com/database + weekly + 0.5 + + + + https://supabase.com/edge-functions + weekly + 0.5 + + + + https://supabase.com/enterprise + weekly + 0.5 + + + + https://supabase.com/events + weekly + 0.5 + + + + https://supabase.com/features + weekly + 0.5 + + + + https://supabase.com/ga-week + weekly + 0.5 + + + + https://supabase.com/ga + weekly + 0.5 + + + + https://supabase.com + weekly + 0.5 + + + + https://supabase.com/launch-week/12 + weekly + 0.5 + + + + https://supabase.com/launch-week/6 + weekly + 0.5 + + + + https://supabase.com/launch-week/7 + weekly + 0.5 + + + + https://supabase.com/launch-week/8 + weekly + 0.5 + + + + https://supabase.com/launch-week + weekly + 0.5 + + + + https://supabase.com/launch-week/x + weekly + 0.5 + + + + https://supabase.com/legal/dpa + weekly + 0.5 + + + + https://supabase.com/modules/cron + weekly + 0.5 + + + + https://supabase.com/modules/queues + weekly + 0.5 + + + + https://supabase.com/modules/vector + weekly + 0.5 + + + + https://supabase.com/nextjs + weekly + 0.5 + + + + https://supabase.com/open-source + weekly + 0.5 + + + + https://supabase.com/opt-out/[ref] + weekly + 0.5 + + + + https://supabase.com/opt-out + weekly + 0.5 + + + + https://supabase.com/partners + weekly + 0.5 + + + + https://supabase.com/partners/integrations + weekly + 0.5 + + + + https://supabase.com/pricing + weekly + 0.5 + + + + https://supabase.com/privacy-240804 + weekly + 0.5 + + + + https://supabase.com/privacy + weekly + 0.5 + + + + https://supabase.com/realtime + weekly + 0.5 + + + + https://supabase.com/security + weekly + 0.5 + + + + https://supabase.com/sla + weekly + 0.5 + + + + https://supabase.com/storage + weekly + 0.5 + + + + https://supabase.com/support-policy + weekly + 0.5 + + + + https://supabase.com/support + weekly + 0.5 + + + + https://supabase.com/terms weekly 0.5 diff --git a/packages/pg-meta/package.json b/packages/pg-meta/package.json index cb9ab3074fa..e46a2568b72 100644 --- a/packages/pg-meta/package.json +++ b/packages/pg-meta/package.json @@ -22,6 +22,6 @@ "pg": "^8.13.1", "postgres-array": "^3.0.2", "typescript": "~5.5.0", - "vitest": "^2.1.8" + "vitest": "^3.0.0" } } diff --git a/packages/ui/package.json b/packages/ui/package.json index c20eafc37a1..5e1ae4ccf8e 100644 --- a/packages/ui/package.json +++ b/packages/ui/package.json @@ -19,7 +19,6 @@ "dependencies": { "@headlessui/react": "^1.7.17", "@hookform/resolvers": "^3.1.1", - "@mertasan/tailwindcss-variables": "^2.2.3", "@radix-ui/react-accordion": "^1.1.2", "@radix-ui/react-alert-dialog": "^1.0.5", "@radix-ui/react-aspect-ratio": "^1.0.3", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c7f9b4cdd89..b4f3a68d7f3 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -220,17 +220,17 @@ importers: specifier: ^14.2.3 version: 14.2.3(@mdx-js/loader@2.3.0(supports-color@8.1.1)(webpack@5.94.0))(@mdx-js/react@2.3.0(react@18.2.0)) '@octokit/auth-app': - specifier: ^6.0.3 - version: 6.0.3 + specifier: ^7.0.0 + version: 7.1.5 '@octokit/core': - specifier: ^5.1.0 - version: 5.1.0 + specifier: ^6.0.0 + version: 6.1.4 '@octokit/graphql': - specifier: ^7.0.2 - version: 7.0.2 + specifier: ^8.0.0 + version: 8.2.1 '@octokit/plugin-paginate-graphql': specifier: ^4.0.0 - version: 4.0.0(@octokit/core@5.1.0) + version: 4.0.0(@octokit/core@6.1.4) '@radix-ui/react-accordion': specifier: ^1.1.2 version: 1.1.2(@types/react-dom@18.3.0)(@types/react@18.3.3)(react-dom@18.2.0(react@18.2.0))(react@18.2.0) @@ -1011,20 +1011,20 @@ importers: specifier: ^14.2.3 version: 14.2.3(@mdx-js/loader@2.3.0(supports-color@8.1.1)(webpack@5.94.0(esbuild@0.21.5)))(@mdx-js/react@2.3.0(react@18.2.0)) '@octokit/auth-app': - specifier: ^6.0.3 - version: 6.0.3 + specifier: ^7.0.0 + version: 7.1.5 '@octokit/core': - specifier: ^5.0.2 - version: 5.1.0 + specifier: ^6.0.0 + version: 6.1.4 '@octokit/graphql': - specifier: ^7.0.2 - version: 7.0.2 + specifier: ^8.0.0 + version: 8.2.1 '@octokit/plugin-paginate-graphql': specifier: ^4.0.0 - version: 4.0.0(@octokit/core@5.1.0) + version: 4.0.0(@octokit/core@6.1.4) '@octokit/rest': - specifier: ^20.0.2 - version: 20.0.2 + specifier: ^21.0.0 + version: 21.1.1 '@radix-ui/react-dialog': specifier: ^1.0.5 version: 1.0.5(@types/react-dom@18.3.0)(@types/react@18.3.3)(react-dom@18.2.0(react@18.2.0))(react@18.2.0) @@ -1393,7 +1393,7 @@ importers: dependencies: '@mertasan/tailwindcss-variables': specifier: ^2.2.3 - version: 2.7.0(autoprefixer@10.4.16(postcss@8.4.38))(postcss@8.4.38) + version: 2.7.0(autoprefixer@10.4.16(postcss@8.5.3))(postcss@8.5.3) '@radix-ui/colors': specifier: ^0.1.8 version: 0.1.9 @@ -1494,8 +1494,8 @@ importers: specifier: ~5.5.0 version: 5.5.2 vitest: - specifier: ^2.1.8 - version: 2.1.8(@types/node@22.13.4)(jsdom@20.0.3(supports-color@8.1.1))(msw@2.4.11(typescript@5.5.2))(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0) + specifier: ^3.0.0 + version: 3.0.4(@types/node@22.13.4)(@vitest/ui@3.0.4)(jsdom@20.0.3(supports-color@8.1.1))(msw@2.4.11(typescript@5.5.2))(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0) packages/shared-data: {} @@ -1509,9 +1509,6 @@ importers: '@hookform/resolvers': specifier: ^3.1.1 version: 3.3.1(react-hook-form@7.47.0(react@18.2.0)) - '@mertasan/tailwindcss-variables': - specifier: ^2.2.3 - version: 2.7.0(autoprefixer@10.4.16(postcss@8.4.38))(postcss@8.4.38) '@radix-ui/react-accordion': specifier: ^1.1.2 version: 1.1.2(@types/react-dom@18.3.0)(@types/react@18.3.3)(react-dom@18.2.0(react@18.2.0))(react@18.2.0) @@ -1646,7 +1643,7 @@ importers: version: 0.436.0(react@18.2.0) next: specifier: 'catalog:' - version: 14.2.21(@babel/core@7.26.9(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0) + version: 14.2.21(@babel/core@7.24.7(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0) next-themes: specifier: ^0.3.0 version: 0.3.0(react-dom@18.2.0(react@18.2.0))(react@18.2.0) @@ -1845,7 +1842,7 @@ importers: version: 0.33.0 next: specifier: 'catalog:' - version: 14.2.21(@babel/core@7.26.9(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0) + version: 14.2.21(@babel/core@7.24.7(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0) next-themes: specifier: '*' version: 0.3.0(react-dom@18.2.0(react@18.2.0))(react@18.2.0) @@ -1942,7 +1939,7 @@ importers: version: link:../api-types next-router-mock: specifier: ^0.9.13 - version: 0.9.13(next@14.2.21(@babel/core@7.26.9(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0))(react@18.2.0) + version: 0.9.13(next@14.2.21(@babel/core@7.24.7(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0))(react@18.2.0) typescript: specifier: ~5.5.0 version: 5.5.2 @@ -2622,12 +2619,6 @@ packages: cpu: [ppc64] os: [aix] - '@esbuild/aix-ppc64@0.20.2': - resolution: {integrity: sha512-D+EBOJHXdNZcLJRBkhENNG8Wji2kgc9AZ9KiPr1JuZjsNtyHzrsfLRrY0tk2H2aoFu6RANO1y1iPPUCDYWkb5g==} - engines: {node: '>=12'} - cpu: [ppc64] - os: [aix] - '@esbuild/aix-ppc64@0.21.5': resolution: {integrity: sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==} engines: {node: '>=12'} @@ -2640,12 +2631,6 @@ packages: cpu: [arm64] os: [android] - '@esbuild/android-arm64@0.20.2': - resolution: {integrity: sha512-mRzjLacRtl/tWU0SvD8lUEwb61yP9cqQo6noDZP/O8VkwafSYwZ4yWy24kan8jE/IMERpYncRt2dw438LP3Xmg==} - engines: {node: '>=12'} - cpu: [arm64] - os: [android] - '@esbuild/android-arm64@0.21.5': resolution: {integrity: sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==} engines: {node: '>=12'} @@ -2658,12 +2643,6 @@ packages: cpu: [arm] os: [android] - '@esbuild/android-arm@0.20.2': - resolution: {integrity: sha512-t98Ra6pw2VaDhqNWO2Oph2LXbz/EJcnLmKLGBJwEwXX/JAN83Fym1rU8l0JUWK6HkIbWONCSSatf4sf2NBRx/w==} - engines: {node: '>=12'} - cpu: [arm] - os: [android] - '@esbuild/android-arm@0.21.5': resolution: {integrity: sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==} engines: {node: '>=12'} @@ -2676,12 +2655,6 @@ packages: cpu: [x64] os: [android] - '@esbuild/android-x64@0.20.2': - resolution: {integrity: sha512-btzExgV+/lMGDDa194CcUQm53ncxzeBrWJcncOBxuC6ndBkKxnHdFJn86mCIgTELsooUmwUm9FkhSp5HYu00Rg==} - engines: {node: '>=12'} - cpu: [x64] - os: [android] - '@esbuild/android-x64@0.21.5': resolution: {integrity: sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==} engines: {node: '>=12'} @@ -2694,12 +2667,6 @@ packages: cpu: [arm64] os: [darwin] - '@esbuild/darwin-arm64@0.20.2': - resolution: {integrity: sha512-4J6IRT+10J3aJH3l1yzEg9y3wkTDgDk7TSDFX+wKFiWjqWp/iCfLIYzGyasx9l0SAFPT1HwSCR+0w/h1ES/MjA==} - engines: {node: '>=12'} - cpu: [arm64] - os: [darwin] - '@esbuild/darwin-arm64@0.21.5': resolution: {integrity: sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==} engines: {node: '>=12'} @@ -2712,12 +2679,6 @@ packages: cpu: [x64] os: [darwin] - '@esbuild/darwin-x64@0.20.2': - resolution: {integrity: sha512-tBcXp9KNphnNH0dfhv8KYkZhjc+H3XBkF5DKtswJblV7KlT9EI2+jeA8DgBjp908WEuYll6pF+UStUCfEpdysA==} - engines: {node: '>=12'} - cpu: [x64] - os: [darwin] - '@esbuild/darwin-x64@0.21.5': resolution: {integrity: sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==} engines: {node: '>=12'} @@ -2730,12 +2691,6 @@ packages: cpu: [arm64] os: [freebsd] - '@esbuild/freebsd-arm64@0.20.2': - resolution: {integrity: sha512-d3qI41G4SuLiCGCFGUrKsSeTXyWG6yem1KcGZVS+3FYlYhtNoNgYrWcvkOoaqMhwXSMrZRl69ArHsGJ9mYdbbw==} - engines: {node: '>=12'} - cpu: [arm64] - os: [freebsd] - '@esbuild/freebsd-arm64@0.21.5': resolution: {integrity: sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==} engines: {node: '>=12'} @@ -2748,12 +2703,6 @@ packages: cpu: [x64] os: [freebsd] - '@esbuild/freebsd-x64@0.20.2': - resolution: {integrity: sha512-d+DipyvHRuqEeM5zDivKV1KuXn9WeRX6vqSqIDgwIfPQtwMP4jaDsQsDncjTDDsExT4lR/91OLjRo8bmC1e+Cw==} - engines: {node: '>=12'} - cpu: [x64] - os: [freebsd] - '@esbuild/freebsd-x64@0.21.5': resolution: {integrity: sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==} engines: {node: '>=12'} @@ -2766,12 +2715,6 @@ packages: cpu: [arm64] os: [linux] - '@esbuild/linux-arm64@0.20.2': - resolution: {integrity: sha512-9pb6rBjGvTFNira2FLIWqDk/uaf42sSyLE8j1rnUpuzsODBq7FvpwHYZxQ/It/8b+QOS1RYfqgGFNLRI+qlq2A==} - engines: {node: '>=12'} - cpu: [arm64] - os: [linux] - '@esbuild/linux-arm64@0.21.5': resolution: {integrity: sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==} engines: {node: '>=12'} @@ -2784,12 +2727,6 @@ packages: cpu: [arm] os: [linux] - '@esbuild/linux-arm@0.20.2': - resolution: {integrity: sha512-VhLPeR8HTMPccbuWWcEUD1Az68TqaTYyj6nfE4QByZIQEQVWBB8vup8PpR7y1QHL3CpcF6xd5WVBU/+SBEvGTg==} - engines: {node: '>=12'} - cpu: [arm] - os: [linux] - '@esbuild/linux-arm@0.21.5': resolution: {integrity: sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==} engines: {node: '>=12'} @@ -2802,12 +2739,6 @@ packages: cpu: [ia32] os: [linux] - '@esbuild/linux-ia32@0.20.2': - resolution: {integrity: sha512-o10utieEkNPFDZFQm9CoP7Tvb33UutoJqg3qKf1PWVeeJhJw0Q347PxMvBgVVFgouYLGIhFYG0UGdBumROyiig==} - engines: {node: '>=12'} - cpu: [ia32] - os: [linux] - '@esbuild/linux-ia32@0.21.5': resolution: {integrity: sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==} engines: {node: '>=12'} @@ -2820,12 +2751,6 @@ packages: cpu: [loong64] os: [linux] - '@esbuild/linux-loong64@0.20.2': - resolution: {integrity: sha512-PR7sp6R/UC4CFVomVINKJ80pMFlfDfMQMYynX7t1tNTeivQ6XdX5r2XovMmha/VjR1YN/HgHWsVcTRIMkymrgQ==} - engines: {node: '>=12'} - cpu: [loong64] - os: [linux] - '@esbuild/linux-loong64@0.21.5': resolution: {integrity: sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==} engines: {node: '>=12'} @@ -2838,12 +2763,6 @@ packages: cpu: [mips64el] os: [linux] - '@esbuild/linux-mips64el@0.20.2': - resolution: {integrity: sha512-4BlTqeutE/KnOiTG5Y6Sb/Hw6hsBOZapOVF6njAESHInhlQAghVVZL1ZpIctBOoTFbQyGW+LsVYZ8lSSB3wkjA==} - engines: {node: '>=12'} - cpu: [mips64el] - os: [linux] - '@esbuild/linux-mips64el@0.21.5': resolution: {integrity: sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==} engines: {node: '>=12'} @@ -2856,12 +2775,6 @@ packages: cpu: [ppc64] os: [linux] - '@esbuild/linux-ppc64@0.20.2': - resolution: {integrity: sha512-rD3KsaDprDcfajSKdn25ooz5J5/fWBylaaXkuotBDGnMnDP1Uv5DLAN/45qfnf3JDYyJv/ytGHQaziHUdyzaAg==} - engines: {node: '>=12'} - cpu: [ppc64] - os: [linux] - '@esbuild/linux-ppc64@0.21.5': resolution: {integrity: sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==} engines: {node: '>=12'} @@ -2874,12 +2787,6 @@ packages: cpu: [riscv64] os: [linux] - '@esbuild/linux-riscv64@0.20.2': - resolution: {integrity: sha512-snwmBKacKmwTMmhLlz/3aH1Q9T8v45bKYGE3j26TsaOVtjIag4wLfWSiZykXzXuE1kbCE+zJRmwp+ZbIHinnVg==} - engines: {node: '>=12'} - cpu: [riscv64] - os: [linux] - '@esbuild/linux-riscv64@0.21.5': resolution: {integrity: sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==} engines: {node: '>=12'} @@ -2892,12 +2799,6 @@ packages: cpu: [s390x] os: [linux] - '@esbuild/linux-s390x@0.20.2': - resolution: {integrity: sha512-wcWISOobRWNm3cezm5HOZcYz1sKoHLd8VL1dl309DiixxVFoFe/o8HnwuIwn6sXre88Nwj+VwZUvJf4AFxkyrQ==} - engines: {node: '>=12'} - cpu: [s390x] - os: [linux] - '@esbuild/linux-s390x@0.21.5': resolution: {integrity: sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==} engines: {node: '>=12'} @@ -2910,12 +2811,6 @@ packages: cpu: [x64] os: [linux] - '@esbuild/linux-x64@0.20.2': - resolution: {integrity: sha512-1MdwI6OOTsfQfek8sLwgyjOXAu+wKhLEoaOLTjbijk6E2WONYpH9ZU2mNtR+lZ2B4uwr+usqGuVfFT9tMtGvGw==} - engines: {node: '>=12'} - cpu: [x64] - os: [linux] - '@esbuild/linux-x64@0.21.5': resolution: {integrity: sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==} engines: {node: '>=12'} @@ -2928,12 +2823,6 @@ packages: cpu: [x64] os: [netbsd] - '@esbuild/netbsd-x64@0.20.2': - resolution: {integrity: sha512-K8/DhBxcVQkzYc43yJXDSyjlFeHQJBiowJ0uVL6Tor3jGQfSGHNNJcWxNbOI8v5k82prYqzPuwkzHt3J1T1iZQ==} - engines: {node: '>=12'} - cpu: [x64] - os: [netbsd] - '@esbuild/netbsd-x64@0.21.5': resolution: {integrity: sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==} engines: {node: '>=12'} @@ -2946,12 +2835,6 @@ packages: cpu: [x64] os: [openbsd] - '@esbuild/openbsd-x64@0.20.2': - resolution: {integrity: sha512-eMpKlV0SThJmmJgiVyN9jTPJ2VBPquf6Kt/nAoo6DgHAoN57K15ZghiHaMvqjCye/uU4X5u3YSMgVBI1h3vKrQ==} - engines: {node: '>=12'} - cpu: [x64] - os: [openbsd] - '@esbuild/openbsd-x64@0.21.5': resolution: {integrity: sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==} engines: {node: '>=12'} @@ -2964,12 +2847,6 @@ packages: cpu: [x64] os: [sunos] - '@esbuild/sunos-x64@0.20.2': - resolution: {integrity: sha512-2UyFtRC6cXLyejf/YEld4Hajo7UHILetzE1vsRcGL3earZEW77JxrFjH4Ez2qaTiEfMgAXxfAZCm1fvM/G/o8w==} - engines: {node: '>=12'} - cpu: [x64] - os: [sunos] - '@esbuild/sunos-x64@0.21.5': resolution: {integrity: sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==} engines: {node: '>=12'} @@ -2982,12 +2859,6 @@ packages: cpu: [arm64] os: [win32] - '@esbuild/win32-arm64@0.20.2': - resolution: {integrity: sha512-GRibxoawM9ZCnDxnP3usoUDO9vUkpAxIIZ6GQI+IlVmr5kP3zUq+l17xELTHMWTWzjxa2guPNyrpq1GWmPvcGQ==} - engines: {node: '>=12'} - cpu: [arm64] - os: [win32] - '@esbuild/win32-arm64@0.21.5': resolution: {integrity: sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==} engines: {node: '>=12'} @@ -3000,12 +2871,6 @@ packages: cpu: [ia32] os: [win32] - '@esbuild/win32-ia32@0.20.2': - resolution: {integrity: sha512-HfLOfn9YWmkSKRQqovpnITazdtquEW8/SoHW7pWpuEeguaZI4QnCRW6b+oZTztdBnZOS2hqJ6im/D5cPzBTTlQ==} - engines: {node: '>=12'} - cpu: [ia32] - os: [win32] - '@esbuild/win32-ia32@0.21.5': resolution: {integrity: sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==} engines: {node: '>=12'} @@ -3018,12 +2883,6 @@ packages: cpu: [x64] os: [win32] - '@esbuild/win32-x64@0.20.2': - resolution: {integrity: sha512-N49X4lJX27+l9jbLKSqZ6bKNjzQvHaT8IIFUy+YIqmXQdjYCToGWwOItDrfby14c78aDd5NHQl29xingXfCdLQ==} - engines: {node: '>=12'} - cpu: [x64] - os: [win32] - '@esbuild/win32-x64@0.21.5': resolution: {integrity: sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==} engines: {node: '>=12'} @@ -3525,48 +3384,48 @@ packages: react: ^18 || ^19.0.0-rc-915b914b3a-20240515 react-dom: ^18 - '@octokit/auth-app@6.0.3': - resolution: {integrity: sha512-9N7IlBAKEJR3tJgPSubCxIDYGXSdc+2xbkjYpk9nCyqREnH8qEMoMhiEB1WgoA9yTFp91El92XNXAi+AjuKnfw==} + '@octokit/auth-app@7.1.5': + resolution: {integrity: sha512-boklS4E6LpbA3nRx+SU2fRKRGZJdOGoSZne/i3Y0B5rfHOcGwFgcXrwDLdtbv4igfDSnAkZaoNBv1GYjPDKRNw==} engines: {node: '>= 18'} - '@octokit/auth-oauth-app@7.0.1': - resolution: {integrity: sha512-RE0KK0DCjCHXHlQBoubwlLijXEKfhMhKm9gO56xYvFmP1QTMb+vvwRPmQLLx0V+5AvV9N9I3lr1WyTzwL3rMDg==} + '@octokit/auth-oauth-app@8.1.3': + resolution: {integrity: sha512-4e6OjVe5rZ8yBe8w7byBjpKtSXFuro7gqeGAAZc7QYltOF8wB93rJl2FE0a4U1Mt88xxPv/mS+25/0DuLk0Ewg==} engines: {node: '>= 18'} - '@octokit/auth-oauth-device@6.0.1': - resolution: {integrity: sha512-yxU0rkL65QkjbqQedgVx3gmW7YM5fF+r5uaSj9tM/cQGVqloXcqP2xK90eTyYvl29arFVCW8Vz4H/t47mL0ELw==} + '@octokit/auth-oauth-device@7.1.3': + resolution: {integrity: sha512-BECO/N4B/Uikj0w3GCvjf/odMujtYTP3q82BJSjxC2J3rxTEiZIJ+z2xnRlDb0IE9dQSaTgRqUPVOieSbFcVzg==} engines: {node: '>= 18'} - '@octokit/auth-oauth-user@4.0.1': - resolution: {integrity: sha512-N94wWW09d0hleCnrO5wt5MxekatqEJ4zf+1vSe8MKMrhZ7gAXKFOKrDEZW2INltvBWJCyDUELgGRv8gfErH1Iw==} + '@octokit/auth-oauth-user@5.1.3': + resolution: {integrity: sha512-zNPByPn9K7TC+OOHKGxU+MxrE9SZAN11UHYEFLsK2NRn3akJN2LHRl85q+Eypr3tuB2GrKx3rfj2phJdkYCvzw==} engines: {node: '>= 18'} - '@octokit/auth-token@4.0.0': - resolution: {integrity: sha512-tY/msAuJo6ARbK6SPIxZrPBms3xPbfwBrulZe0Wtr/DIY9lje2HeV1uoebShn6mx7SjCHif6EjMvoREj+gZ+SA==} + '@octokit/auth-token@5.1.2': + resolution: {integrity: sha512-JcQDsBdg49Yky2w2ld20IHAlwr8d/d8N6NiOXbtuoPCqzbsiJgF633mVUw3x4mo0H5ypataQIX7SFu3yy44Mpw==} engines: {node: '>= 18'} - '@octokit/core@5.1.0': - resolution: {integrity: sha512-BDa2VAMLSh3otEiaMJ/3Y36GU4qf6GI+VivQ/P41NC6GHcdxpKlqV0ikSZ5gdQsmS3ojXeRx5vasgNTinF0Q4g==} + '@octokit/core@6.1.4': + resolution: {integrity: sha512-lAS9k7d6I0MPN+gb9bKDt7X8SdxknYqAMh44S5L+lNqIN2NuV8nvv3g8rPp7MuRxcOpxpUIATWprO0C34a8Qmg==} engines: {node: '>= 18'} - '@octokit/endpoint@9.0.4': - resolution: {integrity: sha512-DWPLtr1Kz3tv8L0UvXTDP1fNwM0S+z6EJpRcvH66orY6Eld4XBMCSYsaWp4xIm61jTWxK68BrR7ibO+vSDnZqw==} + '@octokit/endpoint@10.1.3': + resolution: {integrity: sha512-nBRBMpKPhQUxCsQQeW+rCJ/OPSMcj3g0nfHn01zGYZXuNDvvXudF/TYY6APj5THlurerpFN4a/dQAIAaM6BYhA==} engines: {node: '>= 18'} - '@octokit/graphql@7.0.2': - resolution: {integrity: sha512-OJ2iGMtj5Tg3s6RaXH22cJcxXRi7Y3EBqbHTBRq+PQAqfaS8f/236fUrWhfSn8P4jovyzqucxme7/vWSSZBX2Q==} + '@octokit/graphql@8.2.1': + resolution: {integrity: sha512-n57hXtOoHrhwTWdvhVkdJHdhTv0JstjDbDRhJfwIRNfFqmSo1DaK/mD2syoNUoLCyqSjBpGAKOG0BuwF392slw==} engines: {node: '>= 18'} - '@octokit/oauth-authorization-url@6.0.2': - resolution: {integrity: sha512-CdoJukjXXxqLNK4y/VOiVzQVjibqoj/xHgInekviUJV73y/BSIcwvJ/4aNHPBPKcPWFnd4/lO9uqRV65jXhcLA==} + '@octokit/oauth-authorization-url@7.1.1': + resolution: {integrity: sha512-ooXV8GBSabSWyhLUowlMIVd9l1s2nsOGQdlP2SQ4LnkEsGXzeCvbSbCPdZThXhEFzleGPwbapT0Sb+YhXRyjCA==} engines: {node: '>= 18'} - '@octokit/oauth-methods@4.0.1': - resolution: {integrity: sha512-1NdTGCoBHyD6J0n2WGXg9+yDLZrRNZ0moTEex/LSPr49m530WNKcCfXDghofYptr3st3eTii+EHoG5k/o+vbtw==} + '@octokit/oauth-methods@5.1.4': + resolution: {integrity: sha512-Jc/ycnePClOvO1WL7tlC+TRxOFtyJBGuTDsL4dzXNiVZvzZdrPuNw7zHI3qJSUX2n6RLXE5L0SkFmYyNaVUFoQ==} engines: {node: '>= 18'} - '@octokit/openapi-types@19.1.0': - resolution: {integrity: sha512-6G+ywGClliGQwRsjvqVYpklIfa7oRPA0vyhPQG/1Feh+B+wU0vGH1JiJ5T25d3g1JZYBHzR2qefLi9x8Gt+cpw==} + '@octokit/openapi-types@23.0.1': + resolution: {integrity: sha512-izFjMJ1sir0jn0ldEKhZ7xegCTj/ObmEDlEfpFrx4k/JyZSMRHbO3/rBwgE7f3m2DHt+RrNGIVw4wSmwnm3t/g==} '@octokit/plugin-paginate-graphql@4.0.0': resolution: {integrity: sha512-7HcYW5tP7/Z6AETAPU14gp5H5KmCPT3hmJrS/5tO7HIgbwenYmgw4OY9Ma54FDySuxMwD+wsJlxtuGWwuZuItA==} @@ -3574,38 +3433,38 @@ packages: peerDependencies: '@octokit/core': '>=5' - '@octokit/plugin-paginate-rest@9.1.4': - resolution: {integrity: sha512-MvZx4WvfhBnt7PtH5XE7HORsO7bBk4er1FgRIUr1qJ89NR2I6bWjGyKsxk8z42FPQ34hFQm0Baanh4gzdZR4gQ==} + '@octokit/plugin-paginate-rest@11.4.3': + resolution: {integrity: sha512-tBXaAbXkqVJlRoA/zQVe9mUdb8rScmivqtpv3ovsC5xhje/a+NOCivs7eUhWBwCApJVsR4G5HMeaLbq7PxqZGA==} engines: {node: '>= 18'} peerDependencies: - '@octokit/core': '>=5' + '@octokit/core': '>=6' - '@octokit/plugin-request-log@4.0.0': - resolution: {integrity: sha512-2uJI1COtYCq8Z4yNSnM231TgH50bRkheQ9+aH8TnZanB6QilOnx8RMD2qsnamSOXtDj0ilxvevf5fGsBhBBzKA==} + '@octokit/plugin-request-log@5.3.1': + resolution: {integrity: sha512-n/lNeCtq+9ofhC15xzmJCNKP2BWTv8Ih2TTy+jatNCCq/gQP/V7rK3fjIfuz0pDWDALO/o/4QY4hyOF6TQQFUw==} engines: {node: '>= 18'} peerDependencies: - '@octokit/core': '>=5' + '@octokit/core': '>=6' - '@octokit/plugin-rest-endpoint-methods@10.1.5': - resolution: {integrity: sha512-LMEdsMV8TTMjMTqVoqMzV95XTbv0ZsWxCxQtjAunQOCdwoDH4BVF/Ke5JMSZEVCWGI2kzxnUNbFnK/MxwV7NjA==} + '@octokit/plugin-rest-endpoint-methods@13.3.1': + resolution: {integrity: sha512-o8uOBdsyR+WR8MK9Cco8dCgvG13H1RlM1nWnK/W7TEACQBFux/vPREgKucxUfuDQ5yi1T3hGf4C5ZmZXAERgwQ==} engines: {node: '>= 18'} peerDependencies: - '@octokit/core': '>=5' + '@octokit/core': '>=6' - '@octokit/request-error@5.0.1': - resolution: {integrity: sha512-X7pnyTMV7MgtGmiXBwmO6M5kIPrntOXdyKZLigNfQWSEQzVxR4a4vo49vJjTWX70mPndj8KhfT4Dx+2Ng3vnBQ==} + '@octokit/request-error@6.1.7': + resolution: {integrity: sha512-69NIppAwaauwZv6aOzb+VVLwt+0havz9GT5YplkeJv7fG7a40qpLt/yZKyiDxAhgz0EtgNdNcb96Z0u+Zyuy2g==} engines: {node: '>= 18'} - '@octokit/request@8.1.6': - resolution: {integrity: sha512-YhPaGml3ncZC1NfXpP3WZ7iliL1ap6tLkAp6MvbK2fTTPytzVUyUesBBogcdMm86uRYO5rHaM1xIWxigWZ17MQ==} + '@octokit/request@9.2.2': + resolution: {integrity: sha512-dZl0ZHx6gOQGcffgm1/Sf6JfEpmh34v3Af2Uci02vzUYz6qEN6zepoRtmybWXIGXFIK8K9ylE3b+duCWqhArtg==} engines: {node: '>= 18'} - '@octokit/rest@20.0.2': - resolution: {integrity: sha512-Ux8NDgEraQ/DMAU1PlAohyfBBXDwhnX2j33Z1nJNziqAfHi70PuxkFYIcIt8aIAxtRE7KVuKp8lSR8pA0J5iOQ==} + '@octokit/rest@21.1.1': + resolution: {integrity: sha512-sTQV7va0IUVZcntzy1q3QqPm/r8rWtDCqpRAmb8eXXnKkjoQEtFe3Nt5GTVsHft+R6jJoHeSiVLcgcvhtue/rg==} engines: {node: '>= 18'} - '@octokit/types@12.4.0': - resolution: {integrity: sha512-FLWs/AvZllw/AGVs+nJ+ELCDZZJk+kY0zMen118xhL2zD0s1etIUHm1odgjP7epxYU1ln7SZxEUWYop5bhsdgQ==} + '@octokit/types@13.8.0': + resolution: {integrity: sha512-x7DjTIbEpEWXK99DMd01QfWy0hd5h4EN+Q7shkdKds3otGQP+oWE/y0A76i1OvH9fygo4ddvNf7ZvF0t78P98A==} '@open-draft/deferred-promise@2.2.0': resolution: {integrity: sha512-CecwLWx3rhxVQF6V4bAgPS5t+So2sTbPgAzafKkVizyi7tlwpcFpdFqq+wqF2OwNBmqFuu6tOyouTuxgpMfzmA==} @@ -5532,9 +5391,6 @@ packages: '@types/babel__traverse@7.20.6': resolution: {integrity: sha512-r1bzfrm0tomOI8g1SzvCaQHo6Lcv6zu0EA+W2kHrt8dyrHQxGzBBL4kdkzIS+jBMV+EYcMAEAqXqYaLJq5rOZg==} - '@types/btoa-lite@1.0.2': - resolution: {integrity: sha512-ZYbcE2x7yrvNFJiU7xJGrpF/ihpkM7zKgw8bha3LNJSesvTtUNxbpzaT7WXBIryf6jovisrxTBvymxMeLLj1Mg==} - '@types/classnames@2.3.1': resolution: {integrity: sha512-zeOWb0JGBoVmlQoznvqXbE0tEC/HONsnoUNH19Hc96NFsTAwTXbTqb8FMYkru1F/iqp7a18Ws3nWJvtA1sHD1A==} deprecated: This is a stub types definition. classnames provides its own type definitions, so you do not need this installed. @@ -5743,9 +5599,6 @@ packages: '@types/json5@0.0.29': resolution: {integrity: sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==} - '@types/jsonwebtoken@9.0.5': - resolution: {integrity: sha512-VRLSGzik+Unrup6BsouBeHsf4d1hOEgYWTm/7Nmw1sXoN1+tRly/Gy/po3yeahnP4jfnQWWAhQAqcNfH7ngOkA==} - '@types/jsrsasign@10.5.12': resolution: {integrity: sha512-sOA+eVnHU+FziThpMhuqs/tjFKe5gHVJKIS7g1BzhXP+e2FS8OvtzM0K3IzFxVksDOr98Gz5FJiZVxZ9uFoHhw==} @@ -6015,23 +5868,9 @@ packages: peerDependencies: vite: ^4.2.0 || ^5.0.0 - '@vitest/expect@2.1.8': - resolution: {integrity: sha512-8ytZ/fFHq2g4PJVAtDX57mayemKgDR6X3Oa2Foro+EygiOJHUXhCqBAAKQYYajZpFoIfvBCF1j6R6IYRSIUFuw==} - '@vitest/expect@3.0.4': resolution: {integrity: sha512-Nm5kJmYw6P2BxhJPkO3eKKhGYKRsnqJqf+r0yOGRKpEP+bSCBDsjXgiu1/5QFrnPMEgzfC38ZEjvCFgaNBC0Eg==} - '@vitest/mocker@2.1.8': - resolution: {integrity: sha512-7guJ/47I6uqfttp33mgo6ga5Gr1VnL58rcqYKyShoRK9ebu8T5Rs6HN3s1NABiBeVTdWNrwUMcHH54uXZBN4zA==} - peerDependencies: - msw: ^2.4.9 - vite: ^5.0.0 - peerDependenciesMeta: - msw: - optional: true - vite: - optional: true - '@vitest/mocker@3.0.4': resolution: {integrity: sha512-gEef35vKafJlfQbnyOXZ0Gcr9IBUsMTyTLXsEQwuyYAerpHqvXhzdBnDFuHLpFqth3F7b6BaFr4qV/Cs1ULx5A==} peerDependencies: @@ -6043,27 +5882,15 @@ packages: vite: optional: true - '@vitest/pretty-format@2.1.8': - resolution: {integrity: sha512-9HiSZ9zpqNLKlbIDRWOnAWqgcA7xu+8YxXSekhr0Ykab7PAYFkhkwoqVArPOtJhPmYeE2YHgKZlj3CP36z2AJQ==} - '@vitest/pretty-format@3.0.4': resolution: {integrity: sha512-ts0fba+dEhK2aC9PFuZ9LTpULHpY/nd6jhAQ5IMU7Gaj7crPCTdCFfgvXxruRBLFS+MLraicCuFXxISEq8C93g==} - '@vitest/runner@2.1.8': - resolution: {integrity: sha512-17ub8vQstRnRlIU5k50bG+QOMLHRhYPAna5tw8tYbj+jzjcspnwnwtPtiOlkuKC4+ixDPTuLZiqiWWQ2PSXHVg==} - '@vitest/runner@3.0.4': resolution: {integrity: sha512-dKHzTQ7n9sExAcWH/0sh1elVgwc7OJ2lMOBrAm73J7AH6Pf9T12Zh3lNE1TETZaqrWFXtLlx3NVrLRb5hCK+iw==} - '@vitest/snapshot@2.1.8': - resolution: {integrity: sha512-20T7xRFbmnkfcmgVEz+z3AU/3b0cEzZOt/zmnvZEctg64/QZbSDJEVm9fLnnlSi74KibmRsO9/Qabi+t0vCRPg==} - '@vitest/snapshot@3.0.4': resolution: {integrity: sha512-+p5knMLwIk7lTQkM3NonZ9zBewzVp9EVkVpvNta0/PlFWpiqLaRcF4+33L1it3uRUCh0BGLOaXPPGEjNKfWb4w==} - '@vitest/spy@2.1.8': - resolution: {integrity: sha512-5swjf2q95gXeYPevtW0BLk6H8+bPlMb4Vw/9Em4hFxDcaOxS+e0LOX4yqNxoHzMR2akEB2xfpnWUzkZokmgWDg==} - '@vitest/spy@3.0.4': resolution: {integrity: sha512-sXIMF0oauYyUy2hN49VFTYodzEAu744MmGcPR3ZBsPM20G+1/cSW/n1U+3Yu/zHxX2bIDe1oJASOkml+osTU6Q==} @@ -6072,9 +5899,6 @@ packages: peerDependencies: vitest: 3.0.4 - '@vitest/utils@2.1.8': - resolution: {integrity: sha512-dwSoui6djdwbfFmIgbIjX2ZhIoG7Ex/+xpxyiEgIGzjliY8xGkcpITKTlp6B4MgtGkF2ilvm97cPM96XZaAgcA==} - '@vitest/utils@3.0.4': resolution: {integrity: sha512-8BqC1ksYsHtbWH+DfpOAKrFw3jl3Uf9J7yeFh85Pz52IWuh1hBBtyfEbRNNZNjl8H8A5yMLH9/t+k7HIKzQcZQ==} @@ -6528,8 +6352,8 @@ packages: base64-js@1.5.1: resolution: {integrity: sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==} - before-after-hook@2.2.3: - resolution: {integrity: sha512-NzUnlZexiaH/46WDhANlyR2bXRopNg4F/zuSA3OpZnllCUgRaOF2znDioDWrmbNVsuZk6l9pMquQB38cfBZwkQ==} + before-after-hook@3.0.2: + resolution: {integrity: sha512-Nik3Sc0ncrMK4UUdXQmAnRtzmNQTAAXmXIopizwZ1W1t8QmfJj+zL4OA2I7XPTPW5z5TDqv4hRo/JzouDJnX3A==} big-integer@1.6.51: resolution: {integrity: sha512-GPEid2Y9QU1Exl1rpO9B2IPJGHPSupF5GnVIP0blYvNOMer2bTvSWs1jGOUg04hTmu67nmLsQ9TBo1puaotBHg==} @@ -6578,12 +6402,6 @@ packages: bser@2.1.1: resolution: {integrity: sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ==} - btoa-lite@1.0.0: - resolution: {integrity: sha512-gvW7InbIyF8AicrqWoptdW08pUxuhq8BEgowNajy9RhiE86fmGAGl+bLKo6oB8QP0CkqHLowfN0oJdKC/J6LbA==} - - buffer-equal-constant-time@1.0.1: - resolution: {integrity: sha512-zRpUiDwd/xk6ADqPMATG8vc9VPrkck7T07OIx0gnjmJAnHnTVXNQG3vfvWNuiZIkwu9KrKdA1iJKfsfTVxE6NA==} - buffer-from@1.1.2: resolution: {integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==} @@ -7263,9 +7081,6 @@ packages: delegates@1.0.0: resolution: {integrity: sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==} - deprecation@2.3.1: - resolution: {integrity: sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==} - dequal@2.0.3: resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} engines: {node: '>=6'} @@ -7356,8 +7171,8 @@ packages: resolution: {integrity: sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==} engines: {node: '>= 4'} - dompurify@2.5.6: - resolution: {integrity: sha512-zUTaUBO8pY4+iJMPE1B9XlO2tXVYIcEA4SNGtvDELzTSCQO7RzH+j7S180BmhmJId78lqGU2z19vgVx2Sxs/PQ==} + dompurify@2.5.8: + resolution: {integrity: sha512-o1vSNgrmYMQObbSSvF/1brBYEQPHhV1+gsmrusO7/GXtp1T9rCS8cXFqVxK/9crT1jA6Ccv+5MTSjBNqr7Sovw==} domutils@3.1.0: resolution: {integrity: sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA==} @@ -7394,9 +7209,6 @@ packages: eastasianwidth@0.2.0: resolution: {integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==} - ecdsa-sig-formatter@1.0.11: - resolution: {integrity: sha512-nagl3RYrbNv6kQkeJIpt6NJZy8twLB/2vtz6yN9Z4vRKHN4/QZJIEbqohALSgwKdnksuY3k5Addp5lg8sVoVcQ==} - ejs@3.1.10: resolution: {integrity: sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==} engines: {node: '>=0.10.0'} @@ -7516,11 +7328,6 @@ packages: engines: {node: '>=12'} hasBin: true - esbuild@0.20.2: - resolution: {integrity: sha512-WdOOppmUNU+IbZ0PaDiTst80zjnrOkyJNHoKupIcVyU8Lvla3Ugx94VzkQ32Ijqd7UhHJy75gNWDMUekcrSJ6g==} - engines: {node: '>=12'} - hasBin: true - esbuild@0.21.5: resolution: {integrity: sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==} engines: {node: '>=12'} @@ -7695,6 +7502,7 @@ packages: resolution: {integrity: sha512-t0q23FIpvHDTtnORW+bDJziGsal5uh9RJTJ1fyH8drd4lICOoXhJ5pLMUZ5C0VQei6dNmwTzzoTRgMkO9JgHEQ==} peerDependencies: eslint: '>= 5' + bundledDependencies: [] eslint-plugin-import@2.29.1: resolution: {integrity: sha512-BbPC0cuExzhiMo4Ff1BTVwHpjjv28C5R+btTOGaCRC7UEz801up0JadwkeSk5Ued6TG34uaczuVuH6qyy5YUxw==} @@ -7873,6 +7681,9 @@ packages: fast-content-type-parse@1.1.0: resolution: {integrity: sha512-fBHHqSTFLVnR61C+gltJuE5GkVQMV0S2nqUO8TJ+5Z3qAKG8vAx4FKai1s5jq/inV1+sREynIWSuQ6HgoSXpDQ==} + fast-content-type-parse@2.0.1: + resolution: {integrity: sha512-nGqtvLrj5w0naR6tDPfB4cUmYCqouzyQiz6C5y/LtcDllJdrcc6WaWW6iXyIIOErTa/XRybj28aasdn4LkVk6Q==} + fast-decode-uri-component@1.0.1: resolution: {integrity: sha512-WKgKWg5eUxvRZGwW8FvfbaH7AXSh2cL+3j5fMGzUMCxWBJ3dV3a7Wz8y2f/uQ0e3B6WmodD3oS54jTQ9HVTIIg==} @@ -9153,10 +8964,6 @@ packages: resolution: {integrity: sha512-SavvDsUP9Xnqo2MoC6Wl6zNyX3f+I5199hRbXBtAITyP2NTPyAgyx5xM0bgcIljRjzsIvOBANbgfWe8XXlyeLA==} hasBin: true - jsonwebtoken@9.0.2: - resolution: {integrity: sha512-PRp66vJ865SSqOlgqS8hujT5U4AOgMfhrwYIuIhfKaoSCZcirrmASQr8CX7cUg+RMih+hgznrjp99o+W4pJLHQ==} - engines: {node: '>=12', npm: '>=6'} - jsox@1.2.121: resolution: {integrity: sha512-9Ag50tKhpTwS6r5wh3MJSAvpSof0UBr39Pto8OnzFT32Z/pAbxAsKHzyvsyMEHVslELvHyO/4/jaQELHk8wDcw==} hasBin: true @@ -9168,12 +8975,6 @@ packages: resolution: {integrity: sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ==} engines: {node: '>=4.0'} - jwa@1.4.1: - resolution: {integrity: sha512-qiLX/xhEEFKUAJ6FiBMbes3w9ATzyk5W7Hvzpa/SLYdxNtng+gcurvrI7TbACjIXlsJyr05/S1oUhZrc63evQA==} - - jws@3.2.2: - resolution: {integrity: sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA==} - katex@0.16.21: resolution: {integrity: sha512-XvqR7FgOHtWupfMiigNzmh+MgUVmDGU2kXZm899ZkPfcuoPuFxyHmXsgATDpFZDAXCI8tvinaVcDo8PIIJSo4A==} hasBin: true @@ -9295,34 +9096,16 @@ packages: lodash.castarray@4.4.0: resolution: {integrity: sha512-aVx8ztPv7/2ULbArGJ2Y42bG1mEQ5mGjpdvrbJcJFU3TbYybe+QlLS4pst9zV52ymy2in1KpFPiZnAOATxD4+Q==} - lodash.includes@4.3.0: - resolution: {integrity: sha512-W3Bx6mdkRTGtlJISOvVD/lbqjTlPPUDTMnlXZFnVwi9NKJ6tiAk6LVdlhZMm17VZisqhKcgzpO5Wz91PCt5b0w==} - - lodash.isboolean@3.0.3: - resolution: {integrity: sha512-Bz5mupy2SVbPHURB98VAcw+aHh4vRV5IPNhILUCsOzRmsTmSQ17jIuqopAentWoehktxGd9e/hbIXq980/1QJg==} - lodash.isequal@4.5.0: resolution: {integrity: sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==} deprecated: This package is deprecated. Use require('node:util').isDeepStrictEqual instead. - lodash.isinteger@4.0.4: - resolution: {integrity: sha512-DBwtEWN2caHQ9/imiNeEA5ys1JoRtRfY3d7V9wkqtbycnAmTvRRmbHKDV4a0EYc678/dia0jrte4tjYwVBaZUA==} - - lodash.isnumber@3.0.3: - resolution: {integrity: sha512-QYqzpfwO3/CWf3XP+Z+tkQsfaLL/EnUlXWVkIk5FUPc4sBdTehEqZONuyRt2P67PXAk+NXmTBcc97zw9t1FQrw==} - lodash.isplainobject@4.0.6: resolution: {integrity: sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA==} - lodash.isstring@4.0.1: - resolution: {integrity: sha512-0wJxfxH1wgO3GrbuP+dTTk7op+6L41QCXbGINEmD+ny/G/eCqGzxyCsh7159S+mgDDcoarnBw6PC1PS5+wUGgw==} - lodash.merge@4.6.2: resolution: {integrity: sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==} - lodash.once@4.1.1: - resolution: {integrity: sha512-Sb487aTOCr9drQVL8pIxOzVhafOjZN9UU54hiN8PU3uAiSV7lx1yYNpbNmex2PK6dSJoNTSJUUswT651yww3Mg==} - lodash.template@4.5.0: resolution: {integrity: sha512-84vYFxIkmidUiFxidA/KjjH9pAycqW+h980j7Fuz5qxRtO9pgB7MDFTdys1N7A5mcucRiDyEq4fusljItR1T/A==} deprecated: This package is deprecated. Use https://socket.dev/npm/package/eta instead. @@ -10514,9 +10297,6 @@ packages: resolution: {integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==} engines: {node: '>=8'} - pathe@1.1.2: - resolution: {integrity: sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ==} - pathe@2.0.2: resolution: {integrity: sha512-15Ztpk+nov8DR524R4BF7uEuzESgzUEAV4Ah7CUMNGXdE5ELuvxElxGXndBl32vMSsWa1jpNf22Z+Er3sKwq+w==} @@ -10744,10 +10524,6 @@ packages: resolution: {integrity: sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==} engines: {node: ^10 || ^12 || >=14} - postcss@8.5.1: - resolution: {integrity: sha512-6oz2beyjc5VMn/KV1pPw8fliQkhBXrVn1Z3TVyqZxU8kZpzEKhBdmCFqI6ZbmGtamQvQGuU1sgPTk8ZrXDD7jQ==} - engines: {node: ^10 || ^12 || >=14} - postcss@8.5.3: resolution: {integrity: sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==} engines: {node: ^10 || ^12 || >=14} @@ -12287,10 +12063,6 @@ packages: resolution: {integrity: sha512-al6n+QEANGFOMf/dmUMsuS5/r9B06uwlyNjZZql/zv8J7ybHCgoihBNORZCY2mzUuAnomQa2JdhyHKzZxPCrFA==} engines: {node: ^18.0.0 || >=20.0.0} - tinyrainbow@1.2.0: - resolution: {integrity: sha512-weEDEq7Z5eTHPDh4xjX789+fHfF+P8boiFB+0vbWzpbnbsEr/GRaohi/uMKxg8RZMXnl1ItAi/IUHWMsjDV7kQ==} - engines: {node: '>=14.0.0'} - tinyrainbow@2.0.0: resolution: {integrity: sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==} engines: {node: '>=14.0.0'} @@ -12641,11 +12413,11 @@ packages: unist-util-visit@5.0.0: resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==} - universal-github-app-jwt@1.1.2: - resolution: {integrity: sha512-t1iB2FmLFE+yyJY9+3wMx0ejB+MQpEVkH0gQv7dR6FZyltyq+ZZO0uDpbopxhrZ3SLEO4dCEkIujOMldEQ2iOA==} + universal-github-app-jwt@2.2.0: + resolution: {integrity: sha512-G5o6f95b5BggDGuUfKDApKaCgNYy2x7OdHY0zSMF081O0EJobw+1130VONhrA7ezGSV2FNOGyM+KQpQZAr9bIQ==} - universal-user-agent@6.0.0: - resolution: {integrity: sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w==} + universal-user-agent@7.0.2: + resolution: {integrity: sha512-0JCqzSKnStlRRQfCdowvqy3cy0Dvtlb8xecj/H8JFZuCze4rwjPZQOgvFvn0Ws/usCHQFGpyr+pB9adaGwXn4Q==} universalify@0.2.0: resolution: {integrity: sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==} @@ -12823,11 +12595,6 @@ packages: victory-vendor@36.6.11: resolution: {integrity: sha512-nT8kCiJp8dQh8g991J/R5w5eE2KnO8EAIP0xocWlh9l2okngMWglOPoMZzJvek8Q1KUc4XE/mJxTZnvOB1sTYg==} - vite-node@2.1.8: - resolution: {integrity: sha512-uPAwSr57kYjAUux+8E2j0q0Fxpn8M9VoyfGiRI8Kfktz9NcYMCenwY5RnZxnF1WTu3TGiYipirIzacLL3VVGFg==} - engines: {node: ^18.0.0 || >=20.0.0} - hasBin: true - vite-node@3.0.4: resolution: {integrity: sha512-7JZKEzcYV2Nx3u6rlvN8qdo3QV7Fxyt6hx+CCKz9fbWxdX5IvUOmTWEAxMrWxaiSf7CKGLJQ5rFu8prb/jBjOA==} engines: {node: ^18.0.0 || ^20.0.0 || >=22.0.0} @@ -12841,34 +12608,6 @@ packages: vite: optional: true - vite@5.2.14: - resolution: {integrity: sha512-TFQLuwWLPms+NBNlh0D9LZQ+HXW471COABxw/9TEUBrjuHMo9BrYBPrN/SYAwIuVL+rLerycxiLT41t4f5MZpA==} - engines: {node: ^18.0.0 || >=20.0.0} - hasBin: true - peerDependencies: - '@types/node': ^18.0.0 || >=20.0.0 - less: '*' - lightningcss: ^1.21.0 - sass: '*' - stylus: '*' - sugarss: '*' - terser: ^5.4.0 - peerDependenciesMeta: - '@types/node': - optional: true - less: - optional: true - lightningcss: - optional: true - sass: - optional: true - stylus: - optional: true - sugarss: - optional: true - terser: - optional: true - vite@5.4.12: resolution: {integrity: sha512-KwUaKB27TvWwDJr1GjjWthLMATbGEbeWYZIbGZ5qFIsgPP3vWzLu4cVooqhm5/Z2SPDUMjyPVjTztm5tYKwQxA==} engines: {node: ^18.0.0 || >=20.0.0} @@ -12900,31 +12639,6 @@ packages: terser: optional: true - vitest@2.1.8: - resolution: {integrity: sha512-1vBKTZskHw/aosXqQUlVWWlGUxSJR8YtiyZDJAFeW2kPAeX6S3Sool0mjspO+kXLuxVWlEDDowBAeqeAQefqLQ==} - engines: {node: ^18.0.0 || >=20.0.0} - hasBin: true - peerDependencies: - '@edge-runtime/vm': '*' - '@types/node': ^18.0.0 || >=20.0.0 - '@vitest/browser': 2.1.8 - '@vitest/ui': 2.1.8 - happy-dom: '*' - jsdom: '*' - peerDependenciesMeta: - '@edge-runtime/vm': - optional: true - '@types/node': - optional: true - '@vitest/browser': - optional: true - '@vitest/ui': - optional: true - happy-dom: - optional: true - jsdom: - optional: true - vitest@3.0.4: resolution: {integrity: sha512-6XG8oTKy2gnJIFTHP6LD7ExFeNLxiTkK3CfMvT7IfR8IN+BYICCf0lXUQmX7i7JoxUP8QmeP4mTnWXgflu4yjw==} engines: {node: ^18.0.0 || ^20.0.0 || >=22.0.0} @@ -14436,207 +14150,138 @@ snapshots: '@esbuild/aix-ppc64@0.19.11': optional: true - '@esbuild/aix-ppc64@0.20.2': - optional: true - '@esbuild/aix-ppc64@0.21.5': optional: true '@esbuild/android-arm64@0.19.11': optional: true - '@esbuild/android-arm64@0.20.2': - optional: true - '@esbuild/android-arm64@0.21.5': optional: true '@esbuild/android-arm@0.19.11': optional: true - '@esbuild/android-arm@0.20.2': - optional: true - '@esbuild/android-arm@0.21.5': optional: true '@esbuild/android-x64@0.19.11': optional: true - '@esbuild/android-x64@0.20.2': - optional: true - '@esbuild/android-x64@0.21.5': optional: true '@esbuild/darwin-arm64@0.19.11': optional: true - '@esbuild/darwin-arm64@0.20.2': - optional: true - '@esbuild/darwin-arm64@0.21.5': optional: true '@esbuild/darwin-x64@0.19.11': optional: true - '@esbuild/darwin-x64@0.20.2': - optional: true - '@esbuild/darwin-x64@0.21.5': optional: true '@esbuild/freebsd-arm64@0.19.11': optional: true - '@esbuild/freebsd-arm64@0.20.2': - optional: true - '@esbuild/freebsd-arm64@0.21.5': optional: true '@esbuild/freebsd-x64@0.19.11': optional: true - '@esbuild/freebsd-x64@0.20.2': - optional: true - '@esbuild/freebsd-x64@0.21.5': optional: true '@esbuild/linux-arm64@0.19.11': optional: true - '@esbuild/linux-arm64@0.20.2': - optional: true - '@esbuild/linux-arm64@0.21.5': optional: true '@esbuild/linux-arm@0.19.11': optional: true - '@esbuild/linux-arm@0.20.2': - optional: true - '@esbuild/linux-arm@0.21.5': optional: true '@esbuild/linux-ia32@0.19.11': optional: true - '@esbuild/linux-ia32@0.20.2': - optional: true - '@esbuild/linux-ia32@0.21.5': optional: true '@esbuild/linux-loong64@0.19.11': optional: true - '@esbuild/linux-loong64@0.20.2': - optional: true - '@esbuild/linux-loong64@0.21.5': optional: true '@esbuild/linux-mips64el@0.19.11': optional: true - '@esbuild/linux-mips64el@0.20.2': - optional: true - '@esbuild/linux-mips64el@0.21.5': optional: true '@esbuild/linux-ppc64@0.19.11': optional: true - '@esbuild/linux-ppc64@0.20.2': - optional: true - '@esbuild/linux-ppc64@0.21.5': optional: true '@esbuild/linux-riscv64@0.19.11': optional: true - '@esbuild/linux-riscv64@0.20.2': - optional: true - '@esbuild/linux-riscv64@0.21.5': optional: true '@esbuild/linux-s390x@0.19.11': optional: true - '@esbuild/linux-s390x@0.20.2': - optional: true - '@esbuild/linux-s390x@0.21.5': optional: true '@esbuild/linux-x64@0.19.11': optional: true - '@esbuild/linux-x64@0.20.2': - optional: true - '@esbuild/linux-x64@0.21.5': optional: true '@esbuild/netbsd-x64@0.19.11': optional: true - '@esbuild/netbsd-x64@0.20.2': - optional: true - '@esbuild/netbsd-x64@0.21.5': optional: true '@esbuild/openbsd-x64@0.19.11': optional: true - '@esbuild/openbsd-x64@0.20.2': - optional: true - '@esbuild/openbsd-x64@0.21.5': optional: true '@esbuild/sunos-x64@0.19.11': optional: true - '@esbuild/sunos-x64@0.20.2': - optional: true - '@esbuild/sunos-x64@0.21.5': optional: true '@esbuild/win32-arm64@0.19.11': optional: true - '@esbuild/win32-arm64@0.20.2': - optional: true - '@esbuild/win32-arm64@0.21.5': optional: true '@esbuild/win32-ia32@0.19.11': optional: true - '@esbuild/win32-ia32@0.20.2': - optional: true - '@esbuild/win32-ia32@0.21.5': optional: true '@esbuild/win32-x64@0.19.11': optional: true - '@esbuild/win32-x64@0.20.2': - optional: true - '@esbuild/win32-x64@0.21.5': optional: true @@ -15252,11 +14897,11 @@ snapshots: '@types/react': 18.3.3 react: 18.2.0 - '@mertasan/tailwindcss-variables@2.7.0(autoprefixer@10.4.16(postcss@8.4.38))(postcss@8.4.38)': + '@mertasan/tailwindcss-variables@2.7.0(autoprefixer@10.4.16(postcss@8.5.3))(postcss@8.5.3)': dependencies: - autoprefixer: 10.4.16(postcss@8.4.38) + autoprefixer: 10.4.16(postcss@8.5.3) lodash: 4.17.21 - postcss: 8.4.38 + postcss: 8.5.3 '@monaco-editor/loader@1.4.0(monaco-editor@0.33.0)': dependencies: @@ -15412,120 +15057,114 @@ snapshots: react: 18.2.0 react-dom: 18.2.0(react@18.2.0) - '@octokit/auth-app@6.0.3': + '@octokit/auth-app@7.1.5': dependencies: - '@octokit/auth-oauth-app': 7.0.1 - '@octokit/auth-oauth-user': 4.0.1 - '@octokit/request': 8.1.6 - '@octokit/request-error': 5.0.1 - '@octokit/types': 12.4.0 - deprecation: 2.3.1 - lru-cache: 10.4.3 - universal-github-app-jwt: 1.1.2 - universal-user-agent: 6.0.0 + '@octokit/auth-oauth-app': 8.1.3 + '@octokit/auth-oauth-user': 5.1.3 + '@octokit/request': 9.2.2 + '@octokit/request-error': 6.1.7 + '@octokit/types': 13.8.0 + toad-cache: 3.7.0 + universal-github-app-jwt: 2.2.0 + universal-user-agent: 7.0.2 - '@octokit/auth-oauth-app@7.0.1': + '@octokit/auth-oauth-app@8.1.3': dependencies: - '@octokit/auth-oauth-device': 6.0.1 - '@octokit/auth-oauth-user': 4.0.1 - '@octokit/request': 8.1.6 - '@octokit/types': 12.4.0 - '@types/btoa-lite': 1.0.2 - btoa-lite: 1.0.0 - universal-user-agent: 6.0.0 + '@octokit/auth-oauth-device': 7.1.3 + '@octokit/auth-oauth-user': 5.1.3 + '@octokit/request': 9.2.2 + '@octokit/types': 13.8.0 + universal-user-agent: 7.0.2 - '@octokit/auth-oauth-device@6.0.1': + '@octokit/auth-oauth-device@7.1.3': dependencies: - '@octokit/oauth-methods': 4.0.1 - '@octokit/request': 8.1.6 - '@octokit/types': 12.4.0 - universal-user-agent: 6.0.0 + '@octokit/oauth-methods': 5.1.4 + '@octokit/request': 9.2.2 + '@octokit/types': 13.8.0 + universal-user-agent: 7.0.2 - '@octokit/auth-oauth-user@4.0.1': + '@octokit/auth-oauth-user@5.1.3': dependencies: - '@octokit/auth-oauth-device': 6.0.1 - '@octokit/oauth-methods': 4.0.1 - '@octokit/request': 8.1.6 - '@octokit/types': 12.4.0 - btoa-lite: 1.0.0 - universal-user-agent: 6.0.0 + '@octokit/auth-oauth-device': 7.1.3 + '@octokit/oauth-methods': 5.1.4 + '@octokit/request': 9.2.2 + '@octokit/types': 13.8.0 + universal-user-agent: 7.0.2 - '@octokit/auth-token@4.0.0': {} + '@octokit/auth-token@5.1.2': {} - '@octokit/core@5.1.0': + '@octokit/core@6.1.4': dependencies: - '@octokit/auth-token': 4.0.0 - '@octokit/graphql': 7.0.2 - '@octokit/request': 8.1.6 - '@octokit/request-error': 5.0.1 - '@octokit/types': 12.4.0 - before-after-hook: 2.2.3 - universal-user-agent: 6.0.0 + '@octokit/auth-token': 5.1.2 + '@octokit/graphql': 8.2.1 + '@octokit/request': 9.2.2 + '@octokit/request-error': 6.1.7 + '@octokit/types': 13.8.0 + before-after-hook: 3.0.2 + universal-user-agent: 7.0.2 - '@octokit/endpoint@9.0.4': + '@octokit/endpoint@10.1.3': dependencies: - '@octokit/types': 12.4.0 - universal-user-agent: 6.0.0 + '@octokit/types': 13.8.0 + universal-user-agent: 7.0.2 - '@octokit/graphql@7.0.2': + '@octokit/graphql@8.2.1': dependencies: - '@octokit/request': 8.1.6 - '@octokit/types': 12.4.0 - universal-user-agent: 6.0.0 + '@octokit/request': 9.2.2 + '@octokit/types': 13.8.0 + universal-user-agent: 7.0.2 - '@octokit/oauth-authorization-url@6.0.2': {} + '@octokit/oauth-authorization-url@7.1.1': {} - '@octokit/oauth-methods@4.0.1': + '@octokit/oauth-methods@5.1.4': dependencies: - '@octokit/oauth-authorization-url': 6.0.2 - '@octokit/request': 8.1.6 - '@octokit/request-error': 5.0.1 - '@octokit/types': 12.4.0 - btoa-lite: 1.0.0 + '@octokit/oauth-authorization-url': 7.1.1 + '@octokit/request': 9.2.2 + '@octokit/request-error': 6.1.7 + '@octokit/types': 13.8.0 - '@octokit/openapi-types@19.1.0': {} + '@octokit/openapi-types@23.0.1': {} - '@octokit/plugin-paginate-graphql@4.0.0(@octokit/core@5.1.0)': + '@octokit/plugin-paginate-graphql@4.0.0(@octokit/core@6.1.4)': dependencies: - '@octokit/core': 5.1.0 + '@octokit/core': 6.1.4 - '@octokit/plugin-paginate-rest@9.1.4(@octokit/core@5.1.0)': + '@octokit/plugin-paginate-rest@11.4.3(@octokit/core@6.1.4)': dependencies: - '@octokit/core': 5.1.0 - '@octokit/types': 12.4.0 + '@octokit/core': 6.1.4 + '@octokit/types': 13.8.0 - '@octokit/plugin-request-log@4.0.0(@octokit/core@5.1.0)': + '@octokit/plugin-request-log@5.3.1(@octokit/core@6.1.4)': dependencies: - '@octokit/core': 5.1.0 + '@octokit/core': 6.1.4 - '@octokit/plugin-rest-endpoint-methods@10.1.5(@octokit/core@5.1.0)': + '@octokit/plugin-rest-endpoint-methods@13.3.1(@octokit/core@6.1.4)': dependencies: - '@octokit/core': 5.1.0 - '@octokit/types': 12.4.0 + '@octokit/core': 6.1.4 + '@octokit/types': 13.8.0 - '@octokit/request-error@5.0.1': + '@octokit/request-error@6.1.7': dependencies: - '@octokit/types': 12.4.0 - deprecation: 2.3.1 - once: 1.4.0 + '@octokit/types': 13.8.0 - '@octokit/request@8.1.6': + '@octokit/request@9.2.2': dependencies: - '@octokit/endpoint': 9.0.4 - '@octokit/request-error': 5.0.1 - '@octokit/types': 12.4.0 - universal-user-agent: 6.0.0 + '@octokit/endpoint': 10.1.3 + '@octokit/request-error': 6.1.7 + '@octokit/types': 13.8.0 + fast-content-type-parse: 2.0.1 + universal-user-agent: 7.0.2 - '@octokit/rest@20.0.2': + '@octokit/rest@21.1.1': dependencies: - '@octokit/core': 5.1.0 - '@octokit/plugin-paginate-rest': 9.1.4(@octokit/core@5.1.0) - '@octokit/plugin-request-log': 4.0.0(@octokit/core@5.1.0) - '@octokit/plugin-rest-endpoint-methods': 10.1.5(@octokit/core@5.1.0) + '@octokit/core': 6.1.4 + '@octokit/plugin-paginate-rest': 11.4.3(@octokit/core@6.1.4) + '@octokit/plugin-request-log': 5.3.1(@octokit/core@6.1.4) + '@octokit/plugin-rest-endpoint-methods': 13.3.1(@octokit/core@6.1.4) - '@octokit/types@12.4.0': + '@octokit/types@13.8.0': dependencies: - '@octokit/openapi-types': 19.1.0 + '@octokit/openapi-types': 23.0.1 '@open-draft/deferred-promise@2.2.0': {} @@ -17859,8 +17498,6 @@ snapshots: '@babel/types': 7.26.9 optional: true - '@types/btoa-lite@1.0.2': {} - '@types/classnames@2.3.1': dependencies: classnames: 2.3.2 @@ -18096,10 +17733,6 @@ snapshots: '@types/json5@0.0.29': {} - '@types/jsonwebtoken@9.0.5': - dependencies: - '@types/node': 22.12.0 - '@types/jsrsasign@10.5.12': {} '@types/katex@0.16.7': {} @@ -18407,13 +18040,6 @@ snapshots: transitivePeerDependencies: - supports-color - '@vitest/expect@2.1.8': - dependencies: - '@vitest/spy': 2.1.8 - '@vitest/utils': 2.1.8 - chai: 5.1.2 - tinyrainbow: 1.2.0 - '@vitest/expect@3.0.4': dependencies: '@vitest/spy': 3.0.4 @@ -18421,15 +18047,6 @@ snapshots: chai: 5.1.2 tinyrainbow: 2.0.0 - '@vitest/mocker@2.1.8(msw@2.4.11(typescript@5.5.2))(vite@5.2.14(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0))': - dependencies: - '@vitest/spy': 2.1.8 - estree-walker: 3.0.3 - magic-string: 0.30.17 - optionalDependencies: - msw: 2.4.11(typescript@5.5.2) - vite: 5.2.14(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0) - '@vitest/mocker@3.0.4(msw@2.4.11(typescript@5.5.2))(vite@5.4.12(@types/node@20.12.11)(sass@1.72.0)(terser@5.39.0))': dependencies: '@vitest/spy': 3.0.4 @@ -18439,40 +18056,30 @@ snapshots: msw: 2.4.11(typescript@5.5.2) vite: 5.4.12(@types/node@20.12.11)(sass@1.72.0)(terser@5.39.0) - '@vitest/pretty-format@2.1.8': + '@vitest/mocker@3.0.4(msw@2.4.11(typescript@5.5.2))(vite@5.4.12(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0))': dependencies: - tinyrainbow: 1.2.0 + '@vitest/spy': 3.0.4 + estree-walker: 3.0.3 + magic-string: 0.30.17 + optionalDependencies: + msw: 2.4.11(typescript@5.5.2) + vite: 5.4.12(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0) '@vitest/pretty-format@3.0.4': dependencies: tinyrainbow: 2.0.0 - '@vitest/runner@2.1.8': - dependencies: - '@vitest/utils': 2.1.8 - pathe: 1.1.2 - '@vitest/runner@3.0.4': dependencies: '@vitest/utils': 3.0.4 pathe: 2.0.2 - '@vitest/snapshot@2.1.8': - dependencies: - '@vitest/pretty-format': 2.1.8 - magic-string: 0.30.17 - pathe: 1.1.2 - '@vitest/snapshot@3.0.4': dependencies: '@vitest/pretty-format': 3.0.4 magic-string: 0.30.17 pathe: 2.0.2 - '@vitest/spy@2.1.8': - dependencies: - tinyspy: 3.0.2 - '@vitest/spy@3.0.4': dependencies: tinyspy: 3.0.2 @@ -18488,12 +18095,6 @@ snapshots: tinyrainbow: 2.0.0 vitest: 3.0.4(@types/node@20.12.11)(@vitest/ui@3.0.4)(jsdom@20.0.3(supports-color@8.1.1))(msw@2.4.11(typescript@5.5.2))(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0) - '@vitest/utils@2.1.8': - dependencies: - '@vitest/pretty-format': 2.1.8 - loupe: 3.1.2 - tinyrainbow: 1.2.0 - '@vitest/utils@3.0.4': dependencies: '@vitest/pretty-format': 3.0.4 @@ -18958,6 +18559,16 @@ snapshots: postcss: 8.4.38 postcss-value-parser: 4.2.0 + autoprefixer@10.4.16(postcss@8.5.3): + dependencies: + browserslist: 4.23.3 + caniuse-lite: 1.0.30001651 + fraction.js: 4.3.6 + normalize-range: 0.1.2 + picocolors: 1.0.1 + postcss: 8.5.3 + postcss-value-parser: 4.2.0 + available-typed-arrays@1.0.7: dependencies: possible-typed-array-names: 1.0.0 @@ -19056,7 +18667,7 @@ snapshots: base64-js@1.5.1: {} - before-after-hook@2.2.3: {} + before-after-hook@3.0.2: {} big-integer@1.6.51: {} @@ -19109,10 +18720,6 @@ snapshots: node-int64: 0.4.0 optional: true - btoa-lite@1.0.0: {} - - buffer-equal-constant-time@1.0.1: {} - buffer-from@1.1.2: {} buffer-writer@2.0.0: {} @@ -19883,8 +19490,6 @@ snapshots: delegates@1.0.0: {} - deprecation@2.3.1: {} - dequal@2.0.3: {} derive-valtio@0.1.0(valtio@1.12.0(@types/react@18.3.3)(react@18.2.0)): @@ -19964,7 +19569,7 @@ snapshots: dependencies: domelementtype: 2.3.0 - dompurify@2.5.6: {} + dompurify@2.5.8: {} domutils@3.1.0: dependencies: @@ -19998,10 +19603,6 @@ snapshots: eastasianwidth@0.2.0: {} - ecdsa-sig-formatter@1.0.11: - dependencies: - safe-buffer: 5.2.1 - ejs@3.1.10: dependencies: jake: 10.8.7 @@ -20204,32 +19805,6 @@ snapshots: '@esbuild/win32-ia32': 0.19.11 '@esbuild/win32-x64': 0.19.11 - esbuild@0.20.2: - optionalDependencies: - '@esbuild/aix-ppc64': 0.20.2 - '@esbuild/android-arm': 0.20.2 - '@esbuild/android-arm64': 0.20.2 - '@esbuild/android-x64': 0.20.2 - '@esbuild/darwin-arm64': 0.20.2 - '@esbuild/darwin-x64': 0.20.2 - '@esbuild/freebsd-arm64': 0.20.2 - '@esbuild/freebsd-x64': 0.20.2 - '@esbuild/linux-arm': 0.20.2 - '@esbuild/linux-arm64': 0.20.2 - '@esbuild/linux-ia32': 0.20.2 - '@esbuild/linux-loong64': 0.20.2 - '@esbuild/linux-mips64el': 0.20.2 - '@esbuild/linux-ppc64': 0.20.2 - '@esbuild/linux-riscv64': 0.20.2 - '@esbuild/linux-s390x': 0.20.2 - '@esbuild/linux-x64': 0.20.2 - '@esbuild/netbsd-x64': 0.20.2 - '@esbuild/openbsd-x64': 0.20.2 - '@esbuild/sunos-x64': 0.20.2 - '@esbuild/win32-arm64': 0.20.2 - '@esbuild/win32-ia32': 0.20.2 - '@esbuild/win32-x64': 0.20.2 - esbuild@0.21.5: optionalDependencies: '@esbuild/aix-ppc64': 0.21.5 @@ -20672,6 +20247,8 @@ snapshots: fast-content-type-parse@1.1.0: {} + fast-content-type-parse@2.0.1: {} + fast-decode-uri-component@1.0.1: {} fast-deep-equal@3.1.3: {} @@ -22402,19 +21979,6 @@ snapshots: jsonrepair@3.5.0: {} - jsonwebtoken@9.0.2: - dependencies: - jws: 3.2.2 - lodash.includes: 4.3.0 - lodash.isboolean: 3.0.3 - lodash.isinteger: 4.0.4 - lodash.isnumber: 3.0.3 - lodash.isplainobject: 4.0.6 - lodash.isstring: 4.0.1 - lodash.once: 4.1.1 - ms: 2.1.3 - semver: 7.6.3 - jsox@1.2.121: {} jsrsasign@11.0.0: {} @@ -22426,17 +21990,6 @@ snapshots: object.assign: 4.1.5 object.values: 1.2.0 - jwa@1.4.1: - dependencies: - buffer-equal-constant-time: 1.0.1 - ecdsa-sig-formatter: 1.0.11 - safe-buffer: 5.2.1 - - jws@3.2.2: - dependencies: - jwa: 1.4.1 - safe-buffer: 5.2.1 - katex@0.16.21: dependencies: commander: 8.3.0 @@ -22574,24 +22127,12 @@ snapshots: lodash.castarray@4.4.0: {} - lodash.includes@4.3.0: {} - - lodash.isboolean@3.0.3: {} - lodash.isequal@4.5.0: {} - lodash.isinteger@4.0.4: {} - - lodash.isnumber@3.0.3: {} - lodash.isplainobject@4.0.6: {} - lodash.isstring@4.0.1: {} - lodash.merge@4.6.2: {} - lodash.once@4.1.1: {} - lodash.template@4.5.0: dependencies: lodash._reinterpolate: 3.0.0 @@ -23958,11 +23499,6 @@ snapshots: next: 14.2.21(@babel/core@7.24.7(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0) react: 18.2.0 - next-router-mock@0.9.13(next@14.2.21(@babel/core@7.26.9(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0))(react@18.2.0): - dependencies: - next: 14.2.21(@babel/core@7.26.9(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0) - react: 18.2.0 - next-seo@6.5.0(next@14.2.21(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0))(react-dom@18.2.0(react@18.2.0))(react@18.2.0): dependencies: next: 14.2.21(@babel/core@7.24.7(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0) @@ -24002,34 +23538,6 @@ snapshots: - '@babel/core' - babel-plugin-macros - next@14.2.21(@babel/core@7.26.9(supports-color@8.1.1))(@opentelemetry/api@1.9.0)(@playwright/test@1.49.1)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(sass@1.72.0): - dependencies: - '@next/env': 14.2.21 - '@swc/helpers': 0.5.5 - busboy: 1.6.0 - caniuse-lite: 1.0.30001695 - graceful-fs: 4.2.11 - postcss: 8.4.31 - react: 18.2.0 - react-dom: 18.2.0(react@18.2.0) - styled-jsx: 5.1.1(@babel/core@7.26.9(supports-color@8.1.1))(react@18.2.0) - optionalDependencies: - '@next/swc-darwin-arm64': 14.2.21 - '@next/swc-darwin-x64': 14.2.21 - '@next/swc-linux-arm64-gnu': 14.2.21 - '@next/swc-linux-arm64-musl': 14.2.21 - '@next/swc-linux-x64-gnu': 14.2.21 - '@next/swc-linux-x64-musl': 14.2.21 - '@next/swc-win32-arm64-msvc': 14.2.21 - '@next/swc-win32-ia32-msvc': 14.2.21 - '@next/swc-win32-x64-msvc': 14.2.21 - '@opentelemetry/api': 1.9.0 - '@playwright/test': 1.49.1 - sass: 1.72.0 - transitivePeerDependencies: - - '@babel/core' - - babel-plugin-macros - nice-try@1.0.5: {} no-case@3.0.4: @@ -24488,8 +23996,6 @@ snapshots: path-type@4.0.0: {} - pathe@1.1.2: {} - pathe@2.0.2: {} pathval@2.0.0: {} @@ -24745,12 +24251,6 @@ snapshots: picocolors: 1.0.1 source-map-js: 1.2.0 - postcss@8.5.1: - dependencies: - nanoid: 3.3.8 - picocolors: 1.1.1 - source-map-js: 1.2.1 - postcss@8.5.3: dependencies: nanoid: 3.3.8 @@ -25423,7 +24923,7 @@ snapshots: classnames: 2.3.2 core-js: 3.35.0 decko: 1.2.0 - dompurify: 2.5.6 + dompurify: 2.5.8 eventemitter3: 4.0.7 json-pointer: 0.6.2 lunr: 2.3.9 @@ -26370,13 +25870,6 @@ snapshots: optionalDependencies: '@babel/core': 7.24.7(supports-color@8.1.1) - styled-jsx@5.1.1(@babel/core@7.26.9(supports-color@8.1.1))(react@18.2.0): - dependencies: - client-only: 0.0.1 - react: 18.2.0 - optionalDependencies: - '@babel/core': 7.26.9(supports-color@8.1.1) - stylis@4.3.1: {} sucrase@3.34.0: @@ -26653,8 +26146,6 @@ snapshots: tinypool@1.0.2: {} - tinyrainbow@1.2.0: {} - tinyrainbow@2.0.0: {} tinyspy@3.0.2: {} @@ -27054,12 +26545,9 @@ snapshots: unist-util-is: 6.0.0 unist-util-visit-parents: 6.0.1 - universal-github-app-jwt@1.1.2: - dependencies: - '@types/jsonwebtoken': 9.0.5 - jsonwebtoken: 9.0.2 + universal-github-app-jwt@2.2.0: {} - universal-user-agent@6.0.0: {} + universal-user-agent@7.0.2: {} universalify@0.2.0: {} @@ -27259,13 +26747,13 @@ snapshots: d3-time: 3.1.0 d3-timer: 3.0.1 - vite-node@2.1.8(@types/node@22.13.4)(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0): + vite-node@3.0.4(@types/node@20.12.11)(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0): dependencies: cac: 6.7.14 debug: 4.4.0(supports-color@8.1.1) es-module-lexer: 1.6.0 - pathe: 1.1.2 - vite: 5.4.12(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0) + pathe: 2.0.2 + vite: 5.4.12(@types/node@20.12.11)(sass@1.72.0)(terser@5.39.0) transitivePeerDependencies: - '@types/node' - less @@ -27277,13 +26765,13 @@ snapshots: - supports-color - terser - vite-node@3.0.4(@types/node@20.12.11)(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0): + vite-node@3.0.4(@types/node@22.13.4)(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0): dependencies: cac: 6.7.14 debug: 4.4.0(supports-color@8.1.1) es-module-lexer: 1.6.0 pathe: 2.0.2 - vite: 5.4.12(@types/node@20.12.11)(sass@1.72.0)(terser@5.39.0) + vite: 5.4.12(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0) transitivePeerDependencies: - '@types/node' - less @@ -27306,21 +26794,10 @@ snapshots: - supports-color - typescript - vite@5.2.14(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0): - dependencies: - esbuild: 0.20.2 - postcss: 8.5.1 - rollup: 4.31.0 - optionalDependencies: - '@types/node': 22.13.4 - fsevents: 2.3.3 - sass: 1.72.0 - terser: 5.39.0 - vite@5.4.12(@types/node@20.12.11)(sass@1.72.0)(terser@5.39.0): dependencies: esbuild: 0.21.5 - postcss: 8.5.1 + postcss: 8.5.3 rollup: 4.31.0 optionalDependencies: '@types/node': 20.12.11 @@ -27331,7 +26808,7 @@ snapshots: vite@5.4.12(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0): dependencies: esbuild: 0.21.5 - postcss: 8.5.1 + postcss: 8.5.3 rollup: 4.31.0 optionalDependencies: '@types/node': 22.13.4 @@ -27339,42 +26816,6 @@ snapshots: sass: 1.72.0 terser: 5.39.0 - vitest@2.1.8(@types/node@22.13.4)(jsdom@20.0.3(supports-color@8.1.1))(msw@2.4.11(typescript@5.5.2))(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0): - dependencies: - '@vitest/expect': 2.1.8 - '@vitest/mocker': 2.1.8(msw@2.4.11(typescript@5.5.2))(vite@5.2.14(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0)) - '@vitest/pretty-format': 2.1.8 - '@vitest/runner': 2.1.8 - '@vitest/snapshot': 2.1.8 - '@vitest/spy': 2.1.8 - '@vitest/utils': 2.1.8 - chai: 5.1.2 - debug: 4.3.7(supports-color@8.1.1) - expect-type: 1.1.0 - magic-string: 0.30.17 - pathe: 1.1.2 - std-env: 3.8.0 - tinybench: 2.9.0 - tinyexec: 0.3.2 - tinypool: 1.0.2 - tinyrainbow: 1.2.0 - vite: 5.2.14(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0) - vite-node: 2.1.8(@types/node@22.13.4)(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0) - why-is-node-running: 2.3.0 - optionalDependencies: - '@types/node': 22.13.4 - jsdom: 20.0.3(supports-color@8.1.1) - transitivePeerDependencies: - - less - - lightningcss - - msw - - sass - - sass-embedded - - stylus - - sugarss - - supports-color - - terser - vitest@3.0.4(@types/node@20.12.11)(@vitest/ui@3.0.4)(jsdom@20.0.3(supports-color@8.1.1))(msw@2.4.11(typescript@5.5.2))(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0): dependencies: '@vitest/expect': 3.0.4 @@ -27412,6 +26853,43 @@ snapshots: - supports-color - terser + vitest@3.0.4(@types/node@22.13.4)(@vitest/ui@3.0.4)(jsdom@20.0.3(supports-color@8.1.1))(msw@2.4.11(typescript@5.5.2))(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0): + dependencies: + '@vitest/expect': 3.0.4 + '@vitest/mocker': 3.0.4(msw@2.4.11(typescript@5.5.2))(vite@5.4.12(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0)) + '@vitest/pretty-format': 3.0.4 + '@vitest/runner': 3.0.4 + '@vitest/snapshot': 3.0.4 + '@vitest/spy': 3.0.4 + '@vitest/utils': 3.0.4 + chai: 5.1.2 + debug: 4.4.0(supports-color@8.1.1) + expect-type: 1.1.0 + magic-string: 0.30.17 + pathe: 2.0.2 + std-env: 3.8.0 + tinybench: 2.9.0 + tinyexec: 0.3.2 + tinypool: 1.0.2 + tinyrainbow: 2.0.0 + vite: 5.4.12(@types/node@22.13.4)(sass@1.72.0)(terser@5.39.0) + vite-node: 3.0.4(@types/node@22.13.4)(sass@1.72.0)(supports-color@8.1.1)(terser@5.39.0) + why-is-node-running: 2.3.0 + optionalDependencies: + '@types/node': 22.13.4 + '@vitest/ui': 3.0.4(vitest@3.0.4) + jsdom: 20.0.3(supports-color@8.1.1) + transitivePeerDependencies: + - less + - lightningcss + - msw + - sass + - sass-embedded + - stylus + - sugarss + - supports-color + - terser + vscode-languageserver-types@3.17.5: {} vue@3.5.13(typescript@5.5.2): From d55f6fb780962b15aee36d4e5256756083b018d1 Mon Sep 17 00:00:00 2001 From: Chris Gwilliams <517923+encima@users.noreply.github.com> Date: Mon, 3 Mar 2025 14:03:29 +0200 Subject: [PATCH 07/50] Update metrics documentation (#33893) * add genera deployment instructions for both grafana and prometheus * add supabase-grafana to spellchecks --- .../docs/content/guides/telemetry/metrics.mdx | 256 +++++------------- supa-mdx-lint/Rule003Spelling.toml | 1 + 2 files changed, 64 insertions(+), 193 deletions(-) diff --git a/apps/docs/content/guides/telemetry/metrics.mdx b/apps/docs/content/guides/telemetry/metrics.mdx index ced0f742077..0309a85ab88 100644 --- a/apps/docs/content/guides/telemetry/metrics.mdx +++ b/apps/docs/content/guides/telemetry/metrics.mdx @@ -4,7 +4,7 @@ title: 'Metrics' description: 'Observability for your Supabase project' --- -In addition to the reports and charts built in to the Supabase dashboard, each project hosted on the Supabase platform comes with a [Prometheus](https://prometheus.io/)-compatible metrics endpoint, which can be used to gather insight into the health and status of your project. +In addition to the reports and charts built in to the Supabase dashboard, each project hosted on the Supabase platform comes with a [Prometheus](https://prometheus.io/)-compatible metrics endpoint, updated every minute, which can be used to gather insight into the health and status of your project. You can use this endpoint to ingest data into your own monitoring and alerting infrastructure, as long as it is capable of scraping Prometheus-compatible endpoints, in order to set up custom rules beyond those supported by the Supabase dashboard. @@ -28,13 +28,40 @@ Your project's metrics endpoint is accessible at `https://.supabase > curl https://.supabase.co/customer/v1/privileged/metrics --user 'service_role:' ``` -## Configuring Prometheus +## Supabase Grafana -For self-hosted Prometheus, modify your `prometheus.yaml` file to add a Supabase job, and set the `metrics_path`, `scheme`, `basic_auth` and `targets` parameters. For example: +The pre-configured Supabase Grafana Dashboard is an advanced version of the [Dashboard's Database Reports](https://supabase.com/dashboard/project/_/reports/database). It visualizes over 200 database performance and health metrics. + +![Supabase Grafana](/docs/img/guides/platform/supabase-grafana-prometheus.png) + +Instructions are included in the README for deploying the repository using docker. + +## Using the metrics endpoint in production + +To set up monitoring for your project, you will need two things: + +1. A datastore - a place to store the metrics coming from your Supabase project over time +2. A dashboard - a place to visualize the state of your Supabase project for a defined period + +### Setting up a metrics datastore + +One of the more well-known options is [Prometheus](https://prometheus.io/docs/introduction/overview/) and it is the tool used in this guide. + +You can [self-host](https://prometheus.io/docs/prometheus/latest/installation/) Prometheus or choose a managed service to store your metrics. Some of the providers offering managed Prometheus are: + +- [Digital Ocean](https://marketplace.digitalocean.com/apps/prometheus) +- [AWS](https://aws.amazon.com/prometheus/) +- [Grafana Cloud](https://grafana.com/products/cloud/metrics/) + +Follow the guides for the deployment option you choose + +#### Adding a scrape job to Prometheus + +For Prometheus, modify your `prometheus.yaml` file to add a Supabase job, and set the `metrics_path`, `scheme`, `basic_auth` and `targets` parameters. For example: ```yaml scrape_configs: - - job_name: "MyJob" + - job_name: "MySupabaseJob" metrics_path: "/customer/v1/privileged/metrics" scheme: https basic_auth: @@ -48,198 +75,41 @@ scrape_configs: group: "MyGroupLabel" ``` -Additionally, we [maintain a repo](https://github.com/supabase/supabase-grafana) for a scraping agent to work with Grafana Cloud. +### Setting up a dashboard -## Deploying Supabase Grafana +For this guide, we will be using [Grafana](https://grafana.com/docs/grafana/latest/introduction/). -The pre-configured Supabase Grafana Dashboard is an advanced version of the [Dashboard's Database Reports](https://supabase.com/dashboard/project/_/reports/database). It visualizes over 200 database performance and health metrics and is updated every minute. +You can [self-host](https://grafana.com/docs/grafana/latest/setup-grafana/installation/) Grafana or many providers offer managed Grafana, some of which are listed below: -![Supabase Grafana](/docs/img/guides/platform/supabase-grafana-prometheus.png) +- [DigitalOcean](https://marketplace.digitalocean.com/apps/grafana) +- [AWS](https://aws.amazon.com/grafana/) +- [Grafana Cloud](https://grafana.com/grafana/) -### Deploying locally +Follow the guides of the provider you choose to get Grafana up and running. - - This method uses docker to deploy locally but the same steps can be used to deploy to a dedicated - server, such as [Fly](https://fly.io), [Railway](https://railway.app) or [Digital - Ocean](https://digitalocean.com) +### Adding a data source to Grafana + +In the left-hand menu, select `Data sources` and click `Add new data source`. + +Select `Prometheus` and enter the connection details for the Prometheus instance you have set up. + +Under **Interval behavior**, set the **scraping interval** to 60s and test the data source. Once it has passed, save it. + +### Adding the Supabase dashboard + +In the left-hand menu, select `Dashboards` and click `New`. From the drop-down, select `Import`. + +Copy the raw file from our [supabase-grafana](https://raw.githubusercontent.com/supabase/supabase-grafana/refs/heads/main/grafana/dashboard.json) repository and paste it (or upload the file). + +Click `Load` and the dashboard will load from the project specified in your Prometheus job. + +### Monitoring your project + +You can configure alerts from Prometheus or Grafana. The `supabase-grafana` repository has a selection of [example alerts](https://github.com/supabase/supabase-grafana/blob/main/docs/example-alerts.md) that can be configured. + + + Grafana Cloud has an unofficial integration for scraping Supabase metrics. See their + [docs](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-supabase/) + for instructions on how to configure it but note that it is not full-featured nor is it supported + by Supabase. - -Prerequisites: - -- Must have [Docker](https://www.docker.com/products/docker-desktop/) or a Docker compatible runtime on your machine - - - -Supabase Grafana only tracks metrics while it's active. For monitoring historical trends, it's better to use a dedicated server that can record data continuously. - - - - - - - - - Download the code from the [GitHub repo](https://github.com/supabase/supabase-grafana/tree/main) - - - - - ```sh - git clone https://github.com/supabase/supabase-grafana.git - ``` - - - - - - - - copy the `example.env` into a new `.env` - - - - ```sh - cp .env.example .env - ``` - - - - - - - - - To monitor a single project, add your service_role key from the [API Settings](https://supabase.com/dashboard/project/_/settings/api) and Project ID from the [General Settings](https://supabase.com/dashboard/project/_/settings/general). - - To monitor multiple projects, create an [account access token](https://supabase.com/dashboard/account/tokens) and add it to your `.env` file. - - - - - - - - - - Add the values to your `.env` file: - ```text .env - SUPABASE_PROJECT_REF="your_project_reference" - SUPABASE_SERVICE_ROLE_KEY="your_service_role" - ``` - - - - - ```text .env - SUPABASE_ACCESS_TOKEN="your_access_token" - ``` - - - - - - - - - For security, consider using a [password generator](https://bitwarden.com/password-generator/) - - - - - ```text .env - GRAFANA_PASSWORD="your password" - ``` - - - - - - - - Deploy the server. Once it is active, you can go to localhost:8000/login in the browser - - - - ```text - docker compose up - ``` - - - - - - - Login with your username (default is `admin`) and the password you created in step 4. - - - ![Grafana login](/docs/img/guides/platform/grafana-login.png) - - - - - -### Deploying to Grafana cloud - - - This section describes the Grafana cloud Supabase template, which is created and maintained by - Grafana. - - - - - - - - Go to Grafana\'s [registration form](https://grafana.com/auth/sign-up/create-user?pg=login) and create an account - - - ![Grafana Registration Page](/docs/img/guides/platform/grafana-registration.png) - - - - - - - - Grafana will prompt you to create a stack. Give it a name and continue. - - - ![Create Grafana Stack](/docs/img/guides/platform/create-grafana-stack.png) - - - - - - - - Create a new Dashboard - - - ![Select Grafana Dashboard](/docs/img/guides/platform/select-grafana-dashboard.png) - - - - - - - - - ![Select Grafana Dashboard](/docs/img/guides/platform/supabase-grafana-template.png) - - - - - - - - Add your service_role key from the [API Settings](https://supabase.com/dashboard/project/_/settings/api) and Project ID from the [General Settings](https://supabase.com/dashboard/project/_/settings/general) to your Grafana credentials. Then install your dashboard. - - - ![Add credentials](/docs/img/guides/platform/add-credentials-grafana.png) - - - - - diff --git a/supa-mdx-lint/Rule003Spelling.toml b/supa-mdx-lint/Rule003Spelling.toml index 671d1f4461b..eb261d1af02 100644 --- a/supa-mdx-lint/Rule003Spelling.toml +++ b/supa-mdx-lint/Rule003Spelling.toml @@ -309,6 +309,7 @@ allow_list = [ "supabase-community", "supabase-flutter", "supabase-gdscript", + "supabase-grafana", "supabase-go", "supabase-js", "supabase-kt", From 1655a17e705d146a364d696821ef06e64395f82e Mon Sep 17 00:00:00 2001 From: Joshen Lim Date: Mon, 3 Mar 2025 20:08:15 +0800 Subject: [PATCH 08/50] Add support for configuring realtime settings (#33875) * Add support for configuring realtime settings * Refactor * Fix TS * Fix TS * Smol update * Hide new UI for local selfhosted * Add feature flag * Fix reset logic * Fix * minor refactor * Fix package.json * Simplify --- .../interfaces/Realtime/RealtimeSettings.tsx | 348 ++++++++++++++++++ .../layouts/RealtimeLayout/RealtimeLayout.tsx | 8 +- .../RealtimeLayout/RealtimeMenu.utils.ts | 17 +- apps/studio/components/ui/Forms/FormPanel.tsx | 3 +- apps/studio/data/lint/lint-query.ts | 2 +- apps/studio/data/realtime/keys.ts | 4 + .../data/realtime/realtime-config-mutation.ts | 77 ++++ .../data/realtime/realtime-config-query.ts | 59 +++ apps/studio/package.json | 2 +- .../pages/project/[ref]/realtime/settings.tsx | 27 ++ pnpm-lock.yaml | 16 +- 11 files changed, 553 insertions(+), 10 deletions(-) create mode 100644 apps/studio/components/interfaces/Realtime/RealtimeSettings.tsx create mode 100644 apps/studio/data/realtime/keys.ts create mode 100644 apps/studio/data/realtime/realtime-config-mutation.ts create mode 100644 apps/studio/data/realtime/realtime-config-query.ts create mode 100644 apps/studio/pages/project/[ref]/realtime/settings.tsx diff --git a/apps/studio/components/interfaces/Realtime/RealtimeSettings.tsx b/apps/studio/components/interfaces/Realtime/RealtimeSettings.tsx new file mode 100644 index 00000000000..a56bf523fc2 --- /dev/null +++ b/apps/studio/components/interfaces/Realtime/RealtimeSettings.tsx @@ -0,0 +1,348 @@ +import { zodResolver } from '@hookform/resolvers/zod' +import { PermissionAction } from '@supabase/shared-types/out/constants' +import { useEffect } from 'react' +import { SubmitHandler, useForm } from 'react-hook-form' +import { toast } from 'sonner' +import * as z from 'zod' + +import { useParams } from 'common' +import { ScaffoldSection } from 'components/layouts/Scaffold' +import { convertFromBytes } from 'components/to-be-cleaned/Storage/StorageSettings/StorageSettings.utils' +import AlertError from 'components/ui/AlertError' +import { FormSection, FormSectionContent, FormSectionLabel } from 'components/ui/Forms/FormSection' +import { useRealtimeConfigurationUpdateMutation } from 'data/realtime/realtime-config-mutation' +import { + REALTIME_DEFAULT_CONFIG, + useRealtimeConfigurationQuery, +} from 'data/realtime/realtime-config-query' +import { useCheckPermissions } from 'hooks/misc/useCheckPermissions' +import { + Button, + Card, + CardContent, + CardFooter, + Form_Shadcn_, + FormControl_Shadcn_, + FormField_Shadcn_, + FormMessage_Shadcn_, + Input_Shadcn_, + Switch, +} from 'ui' +import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout' + +const formId = 'realtime-configuration-form' + +const FormSchema = z.object({ + private_only: z.boolean(), + connection_pool: z.coerce.number().min(1).max(100), + max_concurrent_users: z.coerce.number().min(1).max(50000), + max_events_per_second: z.coerce.number().min(1).max(50000), + max_bytes_per_second: z.coerce.number().min(1).max(10000000), + max_channels_per_client: z.coerce.number().min(1).max(10000), + max_joins_per_second: z.coerce.number().min(1).max(5000), +}) + +export const RealtimeSettings = () => { + const { ref: projectRef } = useParams() + const canUpdateConfig = useCheckPermissions(PermissionAction.REALTIME_ADMIN_READ, '*') + + const { data, error, isLoading, isSuccess, isError } = useRealtimeConfigurationQuery({ + projectRef, + }) + const { mutate: updateRealtimeConfig, isLoading: isUpdatingConfig } = + useRealtimeConfigurationUpdateMutation({ + onSuccess: () => { + form.reset(form.getValues()) + toast.success('Successfully updated realtime settings') + }, + }) + + const form = useForm>({ + resolver: zodResolver(FormSchema), + defaultValues: REALTIME_DEFAULT_CONFIG, + }) + + const onSubmit: SubmitHandler> = (data) => { + if (!projectRef) return console.error('Project ref is required') + updateRealtimeConfig({ ref: projectRef, ...data }) + } + + useEffect(() => { + // [Joshen] Temp typed with any - API typing marks all the properties as nullable, + // but checked with Filipe that they're not supposed to + if (data) form.reset(data as any) + }, [isSuccess]) + + return ( + + +
+ {isError ? ( + + ) : ( + + + ( + Channel restrictions} + > + + + + + + + + + )} + /> + + + ( + + Sets connection pool size for Realtime Authorization +

+ } + > + Connection pool size + + } + > + + + + + + + + )} + /> + + + ( + + Sets maximum number of concurrent users rate limit +

+ } + > + Max concurrent users + + } + > + + + + + + + + )} + /> + + + ( + + Sets maximum number of events per second rate per channel limit +

+ } + > + Max events per second + + } + > + + + + + + + + )} + /> + + + { + const { value, unit } = convertFromBytes(field.value ?? 0) + return ( + + Sets maximum number of bytes per second rate per channel limit +

+ } + > + Max bytes per second + + } + > + + + + + + {!!field.value ? ( + + This is equivalent to {value.toFixed(2)} {unit} + + ) : null} + + + ) + }} + /> + + + ( + + Sets maximum number of channels per client rate limit +

+ } + > + Max channels per client + + } + > + + + + + + + + )} + /> + + + ( + + Sets maximum number of joins per second rate limit +

+ } + > + Max joins per second + + } + > + + + + + + + + )} + /> + + + {form.formState.isDirty && ( + + )} + + + + )} + +
+ + ) +} diff --git a/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx b/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx index 60bbd19599c..6ed74861d13 100644 --- a/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx +++ b/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx @@ -14,6 +14,7 @@ export interface RealtimeLayoutProps { const RealtimeLayout = ({ title, children }: PropsWithChildren) => { const project = useSelectedProject() + const enableRealtimeSettings = useFlag('enableRealtimeSettings') const router = useRouter() const page = router.pathname.split('/')[4] @@ -22,7 +23,12 @@ const RealtimeLayout = ({ title, children }: PropsWithChildren} + productMenu={ + + } > {children} diff --git a/apps/studio/components/layouts/RealtimeLayout/RealtimeMenu.utils.ts b/apps/studio/components/layouts/RealtimeLayout/RealtimeMenu.utils.ts index 70bda5eebc5..365c424d57a 100644 --- a/apps/studio/components/layouts/RealtimeLayout/RealtimeMenu.utils.ts +++ b/apps/studio/components/layouts/RealtimeLayout/RealtimeMenu.utils.ts @@ -1,8 +1,13 @@ import type { ProductMenuGroup } from 'components/ui/ProductMenu/ProductMenu.types' import type { Project } from 'data/projects/project-detail-query' +import { IS_PLATFORM } from 'lib/constants' -export const generateRealtimeMenu = (project: Project): ProductMenuGroup[] => { +export const generateRealtimeMenu = ( + project: Project, + flags?: { enableRealtimeSettings: boolean } +): ProductMenuGroup[] => { const ref = project?.ref ?? 'default' + const { enableRealtimeSettings } = flags || {} return [ { @@ -25,6 +30,16 @@ export const generateRealtimeMenu = (project: Project): ProductMenuGroup[] => { url: `/project/${ref}/realtime/policies`, items: [], }, + ...(IS_PLATFORM && enableRealtimeSettings + ? [ + { + name: 'Settings', + key: 'settings', + url: `/project/${ref}/realtime/settings`, + items: [], + }, + ] + : []), ], }, ] diff --git a/apps/studio/components/ui/Forms/FormPanel.tsx b/apps/studio/components/ui/Forms/FormPanel.tsx index 37264c3e660..7e7c88fff66 100644 --- a/apps/studio/components/ui/Forms/FormPanel.tsx +++ b/apps/studio/components/ui/Forms/FormPanel.tsx @@ -11,6 +11,7 @@ interface Props { disabled?: boolean } +/** @deprecated Use Card instead, refer to BasicAuthSettingsForm.tsx for reference */ const FormPanel = ({ children, header, footer }: Props) => ( {header && {header}} @@ -66,4 +67,4 @@ const FormPanelFooter = forwardRef + ['projects', projectRef, 'realtime', 'configuration'] as const, +} diff --git a/apps/studio/data/realtime/realtime-config-mutation.ts b/apps/studio/data/realtime/realtime-config-mutation.ts new file mode 100644 index 00000000000..318172a9fc5 --- /dev/null +++ b/apps/studio/data/realtime/realtime-config-mutation.ts @@ -0,0 +1,77 @@ +import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/react-query' +import { toast } from 'sonner' + +import type { components } from 'data/api' +import { handleError, patch } from 'data/fetchers' +import type { ResponseError } from 'types' +import { realtimeKeys } from './keys' + +export type RealtimeConfigurationUpdateVariables = { + ref: string +} & components['schemas']['UpdateRealtimeConfigBodyDto'] + +export async function updateRealtimeConfiguration({ + ref, + private_only, + connection_pool, + max_concurrent_users, + max_events_per_second, + max_bytes_per_second, + max_channels_per_client, + max_joins_per_second, +}: RealtimeConfigurationUpdateVariables) { + if (!ref) return console.error('Project ref is required') + + const { data, error } = await patch('/platform/projects/{ref}/config/realtime', { + params: { path: { ref } }, + body: { + private_only, + connection_pool, + max_concurrent_users, + max_events_per_second, + max_bytes_per_second, + max_channels_per_client, + max_joins_per_second, + }, + }) + + if (error) handleError(error) + return data +} + +type RealtimeConfigurationUpdateData = Awaited> + +export const useRealtimeConfigurationUpdateMutation = ({ + onSuccess, + onError, + ...options +}: Omit< + UseMutationOptions< + RealtimeConfigurationUpdateData, + ResponseError, + RealtimeConfigurationUpdateVariables + >, + 'mutationFn' +> = {}) => { + const queryClient = useQueryClient() + + return useMutation< + RealtimeConfigurationUpdateData, + ResponseError, + RealtimeConfigurationUpdateVariables + >((vars) => updateRealtimeConfiguration(vars), { + async onSuccess(data, variables, context) { + const { ref } = variables + await queryClient.invalidateQueries(realtimeKeys.configuration(ref)) + await onSuccess?.(data, variables, context) + }, + async onError(data, variables, context) { + if (onError === undefined) { + toast.error(`Failed to update realtime configuration: ${data.message}`) + } else { + onError(data, variables, context) + } + }, + ...options, + }) +} diff --git a/apps/studio/data/realtime/realtime-config-query.ts b/apps/studio/data/realtime/realtime-config-query.ts new file mode 100644 index 00000000000..fa03f6f5840 --- /dev/null +++ b/apps/studio/data/realtime/realtime-config-query.ts @@ -0,0 +1,59 @@ +import { useQuery, UseQueryOptions } from '@tanstack/react-query' + +import { get, handleError } from 'data/fetchers' +import { IS_PLATFORM } from 'lib/constants' +import type { ResponseError } from 'types' +import { realtimeKeys } from './keys' + +export type RealtimeConfigurationVariables = { + projectRef?: string +} + +export const REALTIME_DEFAULT_CONFIG = { + private_only: false, + connection_pool: 2, + max_concurrent_users: 200, + max_events_per_second: 100, + max_bytes_per_second: 100000, + max_channels_per_client: 100, + max_joins_per_second: 100, +} + +export async function getRealtimeConfiguration( + { projectRef }: RealtimeConfigurationVariables, + signal?: AbortSignal +) { + if (!projectRef) throw new Error('Project ref is required') + + const { data, error } = await get(`/platform/projects/{ref}/config/realtime`, { + params: { path: { ref: projectRef } }, + signal, + }) + if (error) { + if ((error as ResponseError).message === 'Custom realtime config for a project not found') { + return REALTIME_DEFAULT_CONFIG + } else { + handleError(error) + } + } + return data +} + +export type RealtimeConfigurationData = Awaited> +export type RealtimeConfigurationError = ResponseError + +export const useRealtimeConfigurationQuery = ( + { projectRef }: RealtimeConfigurationVariables, + { + enabled = true, + ...options + }: UseQueryOptions = {} +) => + useQuery( + realtimeKeys.configuration(projectRef), + ({ signal }) => getRealtimeConfiguration({ projectRef }, signal), + { + enabled: enabled && IS_PLATFORM && typeof projectRef !== 'undefined', + ...options, + } + ) diff --git a/apps/studio/package.json b/apps/studio/package.json index 56c4a4022c9..e71e6ed4ad6 100644 --- a/apps/studio/package.json +++ b/apps/studio/package.json @@ -40,7 +40,7 @@ "@supabase/auth-js": "catalog:", "@supabase/pg-meta": "workspace:*", "@supabase/realtime-js": "catalog:", - "@supabase/shared-types": "0.1.74", + "@supabase/shared-types": "0.1.80", "@supabase/sql-to-rest": "^0.1.6", "@supabase/supabase-js": "catalog:", "@tanstack/react-query": "4.35.7", diff --git a/apps/studio/pages/project/[ref]/realtime/settings.tsx b/apps/studio/pages/project/[ref]/realtime/settings.tsx new file mode 100644 index 00000000000..fc6c50e2170 --- /dev/null +++ b/apps/studio/pages/project/[ref]/realtime/settings.tsx @@ -0,0 +1,27 @@ +import type { NextPageWithLayout } from 'types' + +import { RealtimeSettings } from 'components/interfaces/Realtime/RealtimeSettings' +import DefaultLayout from 'components/layouts/DefaultLayout' +import { PageLayout } from 'components/layouts/PageLayout/PageLayout' +import RealtimeLayout from 'components/layouts/RealtimeLayout/RealtimeLayout' +import { ScaffoldContainer } from 'components/layouts/Scaffold' + +const RealtimePoliciesPage: NextPageWithLayout = () => { + return ( + + + + ) +} + +RealtimePoliciesPage.getLayout = (page) => ( + + + + {page} + + + +) + +export default RealtimePoliciesPage diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b4f3a68d7f3..be18a88564e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -587,8 +587,8 @@ importers: specifier: 'catalog:' version: 2.11.3 '@supabase/shared-types': - specifier: 0.1.74 - version: 0.1.74 + specifier: 0.1.80 + version: 0.1.80 '@supabase/sql-to-rest': specifier: ^0.1.6 version: 0.1.6(encoding@0.1.13)(supports-color@8.1.1) @@ -5158,8 +5158,8 @@ packages: '@supabase/realtime-js@2.11.3': resolution: {integrity: sha512-rMMGtZy2MaSBlNXP5hJZx+ij5JtQGPuBQ7/izE1oKlR1A6SzbN0VWeFTdmDHVa1gcJ72zpQAjbSmByIG6uz/eA==} - '@supabase/shared-types@0.1.74': - resolution: {integrity: sha512-vYbNA6JtV4PNTSuyRQsRBn6v99WMKCBN5wgS2Ezl3n4EGgCoJCvHyQFbNEwbf1vvZVum/j1bAAK3n3io1jxiqA==} + '@supabase/shared-types@0.1.80': + resolution: {integrity: sha512-U2ACit34Up5OzB53dthb50YVGcAUzkuWn0Wq9fXWDdfl4Wlp+euWKSSVUMUIQo+bf2phu3V/PmVHEWR6dpls1g==} '@supabase/sql-to-rest@0.1.6': resolution: {integrity: sha512-06KgjeINtc6405XQvfnchBE1azEsU8G2NElfadmvVHKmHa5l2bFzjbtFbpaYgpgTzccHlcDmBaCgedVf2Gyl8Q==} @@ -14903,6 +14903,12 @@ snapshots: lodash: 4.17.21 postcss: 8.5.3 + '@mertasan/tailwindcss-variables@2.7.0(autoprefixer@10.4.16(postcss@8.5.3))(postcss@8.5.3)': + dependencies: + autoprefixer: 10.4.16(postcss@8.5.3) + lodash: 4.17.21 + postcss: 8.5.3 + '@monaco-editor/loader@1.4.0(monaco-editor@0.33.0)': dependencies: monaco-editor: 0.33.0 @@ -17223,7 +17229,7 @@ snapshots: - bufferutil - utf-8-validate - '@supabase/shared-types@0.1.74': {} + '@supabase/shared-types@0.1.80': {} '@supabase/sql-to-rest@0.1.6(encoding@0.1.13)(supports-color@8.1.1)': dependencies: From ae9ff9f633aa2f218673b809fa4263a36da5f5d5 Mon Sep 17 00:00:00 2001 From: Joshen Lim Date: Mon, 3 Mar 2025 21:33:45 +0800 Subject: [PATCH 09/50] Fix package-lock (#33968) * Fix package-lock * Set the dompurify to 2.5.8. --------- Co-authored-by: Ivan Vasilov --- pnpm-lock.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index be18a88564e..bc206a2b797 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -14903,12 +14903,6 @@ snapshots: lodash: 4.17.21 postcss: 8.5.3 - '@mertasan/tailwindcss-variables@2.7.0(autoprefixer@10.4.16(postcss@8.5.3))(postcss@8.5.3)': - dependencies: - autoprefixer: 10.4.16(postcss@8.5.3) - lodash: 4.17.21 - postcss: 8.5.3 - '@monaco-editor/loader@1.4.0(monaco-editor@0.33.0)': dependencies: monaco-editor: 0.33.0 From ac54d858a172e8f26a5b4f24a60ec098903e096a Mon Sep 17 00:00:00 2001 From: Andrew Valleteau Date: Mon, 3 Mar 2025 15:35:39 +0100 Subject: [PATCH 10/50] chore(docs): setup docs for overrideTypes (#33705) * chore(docs): setup docs for overrideTypes * fix: add overrideTypes to docs section * chore: regen specs * chore: update snapshot * chore: regenerate all specs * revert realtime spec changes --------- Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com> --- .../guides/api/rest/generating-types.mdx | 10 +- .../ref/javascript/typescript-support.mdx | 10 +- .../Reference.typeSpec.test.ts.snap | 312 +- apps/docs/spec/api_v1_openapi.json | 6 +- .../spec/common-client-libs-sections.json | 8 + .../spec/enrichments/tsdoc_v2/combined.json | 12749 ++++++++++------ .../spec/enrichments/tsdoc_v2/gotrue.json | 6387 ++++---- .../tsdoc_v2/gotrue_dereferenced.json | 7732 ++++++---- .../spec/enrichments/tsdoc_v2/postgrest.json | 3795 +++-- .../tsdoc_v2/postgrest_dereferenced.json | 5021 +++--- apps/docs/spec/storage_v0_openapi.json | 25 + apps/docs/spec/supabase_js_v2.yml | 85 + apps/docs/spec/supabase_swift_v2.yml | 8 +- .../transforms/api_v1_openapi_deparsed.json | 6 + .../storage_v0_openapi_deparsed.json | 47 + 15 files changed, 22041 insertions(+), 14160 deletions(-) diff --git a/apps/docs/content/guides/api/rest/generating-types.mdx b/apps/docs/content/guides/api/rest/generating-types.mdx index ad6036620e7..315ef59fb15 100644 --- a/apps/docs/content/guides/api/rest/generating-types.mdx +++ b/apps/docs/content/guides/api/rest/generating-types.mdx @@ -144,7 +144,15 @@ To use `MergeDeep`, set `compilerOptions.strictNullChecks` to `true` in your `ts You can also override the type of an individual successful response if needed: ```ts -const { data } = await supabase.from('countries').select().returns() +// Partial type override allows you to only override some of the properties in your results +const { data } = await supabase.from('countries').select().overrideTypes>() +// For a full replacement of the original return type use the `{ merge: false }` property as second argument +const { data } = await supabase + .from('countries') + .select() + .overrideTypes, { merge: false }>() +// Use it with `maybeSingle` or `single` +const { data } = await supabase.from('countries').select().single().overrideTypes<{ id: string }>() ``` ### Type shorthands diff --git a/apps/docs/docs/ref/javascript/typescript-support.mdx b/apps/docs/docs/ref/javascript/typescript-support.mdx index 3818dddca9f..6525afa9664 100644 --- a/apps/docs/docs/ref/javascript/typescript-support.mdx +++ b/apps/docs/docs/ref/javascript/typescript-support.mdx @@ -149,7 +149,15 @@ You can also override the type of an individual successful response if needed: ```ts -const { data } = await supabase.from('countries').select().returns() +// Partial type override allows you to only override some of the properties in your results +const { data } = await supabase.from('countries').select().overrideTypes>() +// For a full replacement of the original return type use the `{ merge: false }` property as second argument +const { data } = await supabase + .from('countries') + .select() + .overrideTypes, { merge: false }>() +// Use it with `maybeSingle` or `single` +const { data } = await supabase.from('countries').select().single().overrideTypes<{ id: string }>() ``` diff --git a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap index bbd43282922..74f154685a1 100644 --- a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap +++ b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap @@ -909,6 +909,24 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, + "@supabase/auth-js.AuthInvalidJwtError.constructor": { + "name": "@supabase/auth-js.AuthInvalidJwtError.constructor", + "params": [ + { + "name": "message", + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "AuthInvalidJwtError" + } + } + }, "@supabase/auth-js.AuthInvalidTokenResponseError.constructor": { "name": "@supabase/auth-js.AuthInvalidTokenResponseError.constructor", "params": [], @@ -5735,6 +5753,223 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." } }, + "@supabase/auth-js.GoTrueClient.getClaims": { + "name": "@supabase/auth-js.GoTrueClient.getClaims", + "params": [ + { + "name": "jwt", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "jwks", + "type": { + "type": "object", + "properties": [ + { + "name": "keys", + "type": { + "type": "array", + "elemType": { + "type": "object", + "name": "JWK", + "properties": [ + { + "name": "alg", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "key_ops", + "type": { + "type": "array", + "elemType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "name": "kid", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "kty", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "RSA" + }, + { + "type": "literal", + "value": "EC" + }, + { + "type": "literal", + "value": "oct" + } + ] + } + } + ] + } + } + } + ] + } + } + ], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "object", + "properties": [ + { + "name": "claims", + "type": { + "type": "nameOnly", + "name": "JwtPayload" + } + }, + { + "name": "header", + "type": { + "name": "JwtHeader", + "type": "object", + "properties": [ + { + "name": "alg", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "RS256" + }, + { + "type": "literal", + "value": "ES256" + }, + { + "type": "literal", + "value": "HS256" + } + ] + } + }, + { + "name": "kid", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "typ", + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "name": "signature", + "type": { + "type": "nameOnly", + "name": "Uint8Array" + } + } + ] + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "nameOnly", + "name": "AuthError" + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + } + ] + } + } + }, + "comment": { + "tags": [ + { + "tag": "experimental", + "text": "This method may change in future versions." + }, + { + "tag": "description", + "text": "Gets the claims from a JWT. If the JWT is symmetric JWTs, it will call getUser() to verify against the server. If the JWT is asymmetric, it will be verified against the JWKS using the WebCrypto API.\\n" + } + ] + } + }, "@supabase/auth-js.GoTrueClient.getSession": { "name": "@supabase/auth-js.GoTrueClient.getSession", "params": [], @@ -21308,6 +21543,39 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, + "@supabase/postgrest-js.PostgrestBuilder.overrideTypes": { + "name": "@supabase/postgrest-js.PostgrestBuilder.overrideTypes", + "params": [], + "comment": { + "shortText": "Override the type of the returned \`data\` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\\n", + "tags": [ + { + "tag": "example", + "text": "\\n\`\`\`typescript\\n// Merge with existing types (default behavior)\\nconst query = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ custom_field: string }>()\\n\\n// Replace existing types completely\\nconst replaceQuery = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\\n\`\`\`" + } + ] + } + }, + "@supabase/postgrest-js.PostgrestBuilder.returns": { + "name": "@supabase/postgrest-js.PostgrestBuilder.returns", + "params": [], + "ret": { + "type": { + "type": "nameOnly", + "name": "CheckMatchingArrayTypes" + } + }, + "comment": { + "shortText": "Override the type of the returned \`data\`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\\n" + } + ] + } + }, "@supabase/postgrest-js.PostgrestBuilder.setHeader": { "name": "@supabase/postgrest-js.PostgrestBuilder.setHeader", "params": [ @@ -23903,6 +24171,20 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } ] }, + "@supabase/postgrest-js.PostgrestFilterBuilder.overrideTypes": { + "name": "@supabase/postgrest-js.PostgrestFilterBuilder.overrideTypes", + "params": [], + "comment": { + "shortText": "Override the type of the returned \`data\` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\\n", + "tags": [ + { + "tag": "example", + "text": "\\n\`\`\`typescript\\n// Merge with existing types (default behavior)\\nconst query = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ custom_field: string }>()\\n\\n// Replace existing types completely\\nconst replaceQuery = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\\n\`\`\`" + } + ] + } + }, "@supabase/postgrest-js.PostgrestFilterBuilder.range": { "name": "@supabase/postgrest-js.PostgrestFilterBuilder.range", "params": [ @@ -24325,7 +24607,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\`." + "shortText": "Override the type of the returned \`data\`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\\n" + } + ] } }, "@supabase/postgrest-js.PostgrestFilterBuilder.rollback": { @@ -25898,6 +26186,20 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } ] }, + "@supabase/postgrest-js.PostgrestTransformBuilder.overrideTypes": { + "name": "@supabase/postgrest-js.PostgrestTransformBuilder.overrideTypes", + "params": [], + "comment": { + "shortText": "Override the type of the returned \`data\` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\\n", + "tags": [ + { + "tag": "example", + "text": "\\n\`\`\`typescript\\n// Merge with existing types (default behavior)\\nconst query = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ custom_field: string }>()\\n\\n// Replace existing types completely\\nconst replaceQuery = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\\n\`\`\`" + } + ] + } + }, "@supabase/postgrest-js.PostgrestTransformBuilder.range": { "name": "@supabase/postgrest-js.PostgrestTransformBuilder.range", "params": [ @@ -25975,7 +26277,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\`." + "shortText": "Override the type of the returned \`data\`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\\n" + } + ] } }, "@supabase/postgrest-js.PostgrestTransformBuilder.rollback": { diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json index ce2edf917b5..ff478c31d68 100644 --- a/apps/docs/spec/api_v1_openapi.json +++ b/apps/docs/spec/api_v1_openapi.json @@ -3569,7 +3569,11 @@ }, "SecretResponse": { "type": "object", - "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, + "properties": { + "name": { "type": "string" }, + "value": { "type": "string" }, + "updated_at": { "type": "string" } + }, "required": ["name", "value"] }, "CreateSecretBody": { diff --git a/apps/docs/spec/common-client-libs-sections.json b/apps/docs/spec/common-client-libs-sections.json index 970e6dec100..a9206ccf0c4 100644 --- a/apps/docs/spec/common-client-libs-sections.json +++ b/apps/docs/spec/common-client-libs-sections.json @@ -376,6 +376,14 @@ "parent": "modifiers", "type": "function" }, + { + "id": "overrideTypes", + "title": "Partially override or replace type of successful response", + "slug": "db-overrideTypes", + "product": "database", + "parent": "modifiers", + "type": "function" + }, { "id": "explain", "title": "Using explain", diff --git a/apps/docs/spec/enrichments/tsdoc_v2/combined.json b/apps/docs/spec/enrichments/tsdoc_v2/combined.json index 7b18b0747a5..3b14109903f 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/combined.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/combined.json @@ -7390,14 +7390,14 @@ "originalName": "", "children": [ { - "id": 1121, + "id": 1168, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1122, + "id": 1169, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7411,14 +7411,14 @@ ], "signatures": [ { - "id": 1123, + "id": 1170, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1124, + "id": 1171, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -7429,7 +7429,7 @@ } }, { - "id": 1125, + "id": 1172, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -7440,7 +7440,7 @@ } }, { - "id": 1126, + "id": 1173, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -7462,918 +7462,22 @@ ], "type": { "type": "reference", - "id": 1121, + "id": 1168, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, - { - "id": 1128, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1129, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1117, - "name": "AuthError.code" - } - }, - { - "id": 1127, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "id": 1119, - "name": "AuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1122] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1128, 1127] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 30, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1111, - "name": "AuthError" - } - ] - }, - { - "id": 1111, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1112, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 18, - "character": 2 - } - ], - "signatures": [ - { - "id": 1113, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1114, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1115, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1116, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1111, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 1117, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 1119, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1112] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1117, 1119] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 1121, - "name": "AuthApiError" - }, - { - "type": "reference", - "id": 1131, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 1141, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1178, - "name": "AuthImplicitGrantRedirectError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1179, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 2 - } - ], - "signatures": [ - { - "id": 1180, - "name": "new AuthImplicitGrantRedirectError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1181, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1185, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1184, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1185, 1184] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 1178, - "name": "AuthImplicitGrantRedirectError" - }, - "overwrites": { - "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1202, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1203, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1150, - "name": "CustomAuthError.code" - } - }, - { - "id": 1186, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1189, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1188, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1189, 1188] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1200, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1148, - "name": "CustomAuthError.name" - } - }, - { - "id": 1201, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1149, - "name": "CustomAuthError.status" - } - }, - { - "id": 1190, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 2 - } - ], - "signatures": [ - { - "id": 1191, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1196, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1197, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1199, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1198, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1199, 1198] - } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 1194, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 98, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1193, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1195, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1196, 1194, 1193, 1195] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1179] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1202, 1186, 1200, 1201] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1190] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 88, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1141, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1169, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1170, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 83, - "character": 2 - } - ], - "signatures": [ - { - "id": 1171, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1172, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1169, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" - } - }, { "id": 1175, "name": "code", @@ -8397,10 +7501,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -8419,36 +7519,17 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, - "name": "CustomAuthError.code" - } - }, - { - "id": 1173, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1148, - "name": "CustomAuthError.name" + "id": 1164, + "name": "AuthError.code" } }, { @@ -8463,7 +7544,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 57, + "line": 31, "character": 2 } ], @@ -8471,10 +7552,10 @@ "type": "intrinsic", "name": "number" }, - "inheritedFrom": { + "overwrites": { "type": "reference", - "id": 1149, - "name": "CustomAuthError.status" + "id": 1166, + "name": "AuthError.status" } } ], @@ -8482,38 +7563,38 @@ { "title": "Constructors", "kind": 512, - "children": [1170] + "children": [1169] }, { "title": "Properties", "kind": 1024, - "children": [1175, 1173, 1174] + "children": [1175, 1174] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 82, + "line": 30, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1141, - "name": "CustomAuthError" + "id": 1158, + "name": "AuthError" } ] }, { - "id": 1161, - "name": "AuthInvalidTokenResponseError", + "id": 1158, + "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1162, + "id": 1159, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8521,37 +7602,74 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 77, + "line": 18, "character": 2 } ], "signatures": [ { - "id": 1163, - "name": "new AuthInvalidTokenResponseError", + "id": 1160, + "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, + "parameters": [ + { + "id": 1161, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1162, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1163, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "type": { "type": "reference", - "id": 1161, - "name": "AuthInvalidTokenResponseError" + "id": 1158, + "name": "AuthError" }, "overwrites": { "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" + "name": "Error.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" + "name": "Error.constructor" } }, { - "id": 1166, + "id": 1164, "name": "code", "kind": 1024, "kindString": "Property", @@ -8573,9 +7691,260 @@ "type": "intrinsic", "name": "undefined" }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1165, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, { "type": "reference", "name": "ErrorCode" + } + ] + } + }, + { + "id": 1166, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1159] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1164, 1166] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 1168, + "name": "AuthApiError" + }, + { + "type": "reference", + "id": 1178, + "name": "AuthUnknownError" + }, + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1225, + "name": "AuthImplicitGrantRedirectError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1226, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 2 + } + ], + "signatures": [ + { + "id": 1227, + "name": "new AuthImplicitGrantRedirectError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1228, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1229, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1230, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1232, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1231, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1232, 1231] + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 1225, + "name": "AuthImplicitGrantRedirectError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1249, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" }, { "type": "intersection", @@ -8587,7 +7956,7 @@ { "type": "reflection", "declaration": { - "id": 1167, + "id": 1250, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8595,17 +7964,100 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1164, + "id": 1233, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1234, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1236, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1235, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1236, 1235] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 1247, "name": "name", "kind": 1024, "kindString": "Property", @@ -8623,12 +8075,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1165, + "id": 1248, "name": "status", "kind": 1024, "kindString": "Property", @@ -8649,7 +8101,379 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, + "name": "CustomAuthError.status" + } + }, + { + "id": 1237, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 95, + "character": 2 + } + ], + "signatures": [ + { + "id": 1238, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1239, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1243, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 100, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1244, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1246, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1245, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1246, 1245] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 1241, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 98, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1240, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 97, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1242, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 99, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1243, 1241, 1240, 1242] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1226] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1249, 1233, 1247, 1248] + }, + { + "title": "Methods", + "kind": 2048, + "children": [1237] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 88, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1216, + "name": "AuthInvalidCredentialsError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1217, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 83, + "character": 2 + } + ], + "signatures": [ + { + "id": 1218, + "name": "new AuthInvalidCredentialsError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1219, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1216, + "name": "AuthInvalidCredentialsError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1222, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1223, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1220, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1221, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, "name": "CustomAuthError.status" } } @@ -8658,12 +8482,377 @@ { "title": "Constructors", "kind": 512, - "children": [1162] + "children": [1217] }, { "title": "Properties", "kind": 1024, - "children": [1166, 1164, 1165] + "children": [1222, 1220, 1221] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 82, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1301, + "name": "AuthInvalidJwtError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1302, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 162, + "character": 2 + } + ], + "signatures": [ + { + "id": 1303, + "name": "new AuthInvalidJwtError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1304, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1301, + "name": "AuthInvalidJwtError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1307, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1308, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1305, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1306, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1302] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1307, 1305, 1306] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 161, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1208, + "name": "AuthInvalidTokenResponseError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1209, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 2 + } + ], + "signatures": [ + { + "id": 1210, + "name": "new AuthInvalidTokenResponseError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 1208, + "name": "AuthInvalidTokenResponseError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1213, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1214, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1211, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1212, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1209] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1213, 1211, 1212] } ], "sources": [ @@ -8676,20 +8865,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1206, + "id": 1253, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8703,14 +8892,14 @@ ], "signatures": [ { - "id": 1207, + "id": 1254, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1208, + "id": 1255, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -8721,7 +8910,7 @@ } }, { - "id": 1209, + "id": 1256, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -8736,14 +8925,14 @@ { "type": "reflection", "declaration": { - "id": 1210, + "id": 1257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1212, + "id": 1259, "name": "code", "kind": 1024, "kindString": "Property", @@ -8761,7 +8950,7 @@ } }, { - "id": 1211, + "id": 1258, "name": "error", "kind": 1024, "kindString": "Property", @@ -8783,7 +8972,7 @@ { "title": "Properties", "kind": 1024, - "children": [1212, 1211] + "children": [1259, 1258] } ] } @@ -8795,24 +8984,24 @@ ], "type": { "type": "reference", - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1229, + "id": 1276, "name": "code", "kind": 1024, "kindString": "Property", @@ -8834,10 +9023,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -8848,7 +9033,7 @@ { "type": "reflection", "declaration": { - "id": 1230, + "id": 1277, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8856,17 +9041,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1213, + "id": 1260, "name": "details", "kind": 1024, "kindString": "Property", @@ -8888,14 +9077,14 @@ { "type": "reflection", "declaration": { - "id": 1214, + "id": 1261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1216, + "id": 1263, "name": "code", "kind": 1024, "kindString": "Property", @@ -8913,7 +9102,7 @@ } }, { - "id": 1215, + "id": 1262, "name": "error", "kind": 1024, "kindString": "Property", @@ -8935,7 +9124,7 @@ { "title": "Properties", "kind": 1024, - "children": [1216, 1215] + "children": [1263, 1262] } ] } @@ -8945,7 +9134,7 @@ "defaultValue": "null" }, { - "id": 1227, + "id": 1274, "name": "name", "kind": 1024, "kindString": "Property", @@ -8963,12 +9152,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1228, + "id": 1275, "name": "status", "kind": 1024, "kindString": "Property", @@ -8989,12 +9178,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } }, { - "id": 1217, + "id": 1264, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -9008,7 +9197,7 @@ ], "signatures": [ { - "id": 1218, + "id": 1265, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -9016,14 +9205,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1219, + "id": 1266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1223, + "id": 1270, "name": "details", "kind": 1024, "kindString": "Property", @@ -9045,14 +9234,14 @@ { "type": "reflection", "declaration": { - "id": 1224, + "id": 1271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1226, + "id": 1273, "name": "code", "kind": 1024, "kindString": "Property", @@ -9070,7 +9259,7 @@ } }, { - "id": 1225, + "id": 1272, "name": "error", "kind": 1024, "kindString": "Property", @@ -9092,7 +9281,7 @@ { "title": "Properties", "kind": 1024, - "children": [1226, 1225] + "children": [1273, 1272] } ] } @@ -9102,7 +9291,7 @@ "defaultValue": "..." }, { - "id": 1221, + "id": 1268, "name": "message", "kind": 1024, "kindString": "Property", @@ -9121,7 +9310,7 @@ "defaultValue": "..." }, { - "id": 1220, + "id": 1267, "name": "name", "kind": 1024, "kindString": "Property", @@ -9140,7 +9329,7 @@ "defaultValue": "..." }, { - "id": 1222, + "id": 1269, "name": "status", "kind": 1024, "kindString": "Property", @@ -9163,7 +9352,7 @@ { "title": "Properties", "kind": 1024, - "children": [1223, 1221, 1220, 1222] + "children": [1270, 1268, 1267, 1269] } ] } @@ -9176,17 +9365,17 @@ { "title": "Constructors", "kind": 512, - "children": [1206] + "children": [1253] }, { "title": "Properties", "kind": 1024, - "children": [1229, 1213, 1227, 1228] + "children": [1276, 1260, 1274, 1275] }, { "title": "Methods", "kind": 2048, - "children": [1217] + "children": [1264] } ], "sources": [ @@ -9199,20 +9388,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1233, + "id": 1280, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9226,14 +9415,14 @@ ], "signatures": [ { - "id": 1234, + "id": 1281, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1235, + "id": 1282, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -9244,7 +9433,7 @@ } }, { - "id": 1236, + "id": 1283, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -9257,24 +9446,24 @@ ], "type": { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1239, + "id": 1286, "name": "code", "kind": 1024, "kindString": "Property", @@ -9296,10 +9485,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -9310,7 +9495,7 @@ { "type": "reflection", "declaration": { - "id": 1240, + "id": 1287, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9318,17 +9503,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1237, + "id": 1284, "name": "name", "kind": 1024, "kindString": "Property", @@ -9346,12 +9535,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1238, + "id": 1285, "name": "status", "kind": 1024, "kindString": "Property", @@ -9372,7 +9561,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -9381,12 +9570,12 @@ { "title": "Constructors", "kind": 512, - "children": [1233] + "children": [1280] }, { "title": "Properties", "kind": 1024, - "children": [1239, 1237, 1238] + "children": [1286, 1284, 1285] } ], "sources": [ @@ -9399,20 +9588,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1154, + "id": 1201, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9426,31 +9615,31 @@ ], "signatures": [ { - "id": 1155, + "id": 1202, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1158, + "id": 1205, "name": "code", "kind": 1024, "kindString": "Property", @@ -9472,10 +9661,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -9486,7 +9671,7 @@ { "type": "reflection", "declaration": { - "id": 1159, + "id": 1206, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9494,17 +9679,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1156, + "id": 1203, "name": "name", "kind": 1024, "kindString": "Property", @@ -9522,12 +9711,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1157, + "id": 1204, "name": "status", "kind": 1024, "kindString": "Property", @@ -9548,7 +9737,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -9557,12 +9746,12 @@ { "title": "Constructors", "kind": 512, - "children": [1154] + "children": [1201] }, { "title": "Properties", "kind": 1024, - "children": [1158, 1156, 1157] + "children": [1205, 1203, 1204] } ], "sources": [ @@ -9575,20 +9764,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1131, + "id": 1178, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1132, + "id": 1179, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9602,14 +9791,14 @@ ], "signatures": [ { - "id": 1133, + "id": 1180, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1134, + "id": 1181, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -9620,7 +9809,7 @@ } }, { - "id": 1135, + "id": 1182, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -9633,24 +9822,24 @@ ], "type": { "type": "reference", - "id": 1131, + "id": 1178, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, { - "id": 1137, + "id": 1184, "name": "code", "kind": 1024, "kindString": "Property", @@ -9672,10 +9861,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -9686,7 +9871,7 @@ { "type": "reflection", "declaration": { - "id": 1138, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9694,17 +9879,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1117, + "id": 1164, "name": "AuthError.code" } }, { - "id": 1136, + "id": 1183, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -9722,7 +9911,7 @@ } }, { - "id": 1139, + "id": 1186, "name": "status", "kind": 1024, "kindString": "Property", @@ -9752,7 +9941,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1119, + "id": 1166, "name": "AuthError.status" } } @@ -9761,12 +9950,12 @@ { "title": "Constructors", "kind": 512, - "children": [1132] + "children": [1179] }, { "title": "Properties", "kind": 1024, - "children": [1137, 1136, 1139] + "children": [1184, 1183, 1186] } ], "sources": [ @@ -9779,13 +9968,13 @@ "extendedTypes": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] }, { - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", @@ -9795,7 +9984,7 @@ }, "children": [ { - "id": 1243, + "id": 1290, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9809,14 +9998,14 @@ ], "signatures": [ { - "id": 1244, + "id": 1291, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1245, + "id": 1292, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -9827,7 +10016,7 @@ } }, { - "id": 1246, + "id": 1293, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -9838,7 +10027,7 @@ } }, { - "id": 1247, + "id": 1294, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -9854,24 +10043,24 @@ ], "type": { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1251, + "id": 1298, "name": "code", "kind": 1024, "kindString": "Property", @@ -9893,10 +10082,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -9907,7 +10092,7 @@ { "type": "reflection", "declaration": { - "id": 1252, + "id": 1299, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9915,17 +10100,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1249, + "id": 1296, "name": "name", "kind": 1024, "kindString": "Property", @@ -9943,12 +10132,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1248, + "id": 1295, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -9967,13 +10156,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 526, + "id": 547, "name": "WeakPasswordReasons" } } }, { - "id": 1250, + "id": 1297, "name": "status", "kind": 1024, "kindString": "Property", @@ -9994,7 +10183,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -10003,12 +10192,12 @@ { "title": "Constructors", "kind": 512, - "children": [1243] + "children": [1290] }, { "title": "Properties", "kind": 1024, - "children": [1251, 1249, 1248, 1250] + "children": [1298, 1296, 1295, 1297] } ], "sources": [ @@ -10021,20 +10210,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1141, + "id": 1188, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1142, + "id": 1189, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -10048,14 +10237,14 @@ ], "signatures": [ { - "id": 1143, + "id": 1190, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1144, + "id": 1191, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -10066,7 +10255,7 @@ } }, { - "id": 1145, + "id": 1192, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -10077,7 +10266,7 @@ } }, { - "id": 1146, + "id": 1193, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -10088,7 +10277,7 @@ } }, { - "id": 1147, + "id": 1194, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -10110,24 +10299,24 @@ ], "type": { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, { - "id": 1150, + "id": 1197, "name": "code", "kind": 1024, "kindString": "Property", @@ -10149,10 +10338,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -10163,7 +10348,7 @@ { "type": "reflection", "declaration": { - "id": 1151, + "id": 1198, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10171,17 +10356,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1117, + "id": 1164, "name": "AuthError.code" } }, { - "id": 1148, + "id": 1195, "name": "name", "kind": 1024, "kindString": "Property", @@ -10203,7 +10392,7 @@ } }, { - "id": 1149, + "id": 1196, "name": "status", "kind": 1024, "kindString": "Property", @@ -10224,7 +10413,7 @@ }, "overwrites": { "type": "reference", - "id": 1119, + "id": 1166, "name": "AuthError.status" } } @@ -10233,12 +10422,12 @@ { "title": "Constructors", "kind": 512, - "children": [1142] + "children": [1189] }, { "title": "Properties", "kind": 1024, - "children": [1150, 1148, 1149] + "children": [1197, 1195, 1196] } ], "sources": [ @@ -10251,45 +10440,50 @@ "extendedTypes": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1161, + "id": 1208, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1169, + "id": 1216, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1178, + "id": 1225, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" + }, + { + "type": "reference", + "id": 1301, + "name": "AuthInvalidJwtError" } ] }, @@ -10531,10 +10725,10 @@ ], "type": { "type": "reference", - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -10550,14 +10744,14 @@ }, "children": [ { - "id": 1025, + "id": 1046, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1026, + "id": 1047, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -10577,17 +10771,17 @@ }, "parameters": [ { - "id": 1027, + "id": 1048, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -10610,14 +10804,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -10638,7 +10832,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -10663,7 +10857,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -10684,7 +10878,7 @@ "typeArguments": [ { "type": "reference", - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -10696,14 +10890,14 @@ ] }, { - "id": 1022, + "id": 1043, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1023, + "id": 1044, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -10713,17 +10907,17 @@ }, "parameters": [ { - "id": 1024, + "id": 1045, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -10746,14 +10940,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -10778,7 +10972,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -10799,7 +10993,7 @@ "typeArguments": [ { "type": "reference", - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -10815,7 +11009,7 @@ { "title": "Methods", "kind": 2048, - "children": [1025, 1022] + "children": [1046, 1043] } ], "sources": [ @@ -10860,17 +11054,17 @@ "flags": {}, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -10894,7 +11088,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -10918,7 +11112,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -10945,7 +11139,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -10969,7 +11163,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -10993,7 +11187,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -11021,7 +11215,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -11048,7 +11242,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -11072,7 +11266,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -11099,7 +11293,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -11123,7 +11317,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -11147,7 +11341,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -11176,7 +11370,7 @@ "title": "Properties", "kind": 1024, "children": [ - 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + 728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727 ] } ], @@ -11193,7 +11387,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -11215,7 +11409,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -11285,7 +11479,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -11328,10 +11522,10 @@ "flags": {}, "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkParams", "dereferenced": { - "id": 876, + "id": 897, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11347,7 +11541,7 @@ "type": "union", "types": [ { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11362,14 +11556,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -11387,7 +11581,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -11406,7 +11600,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -11429,7 +11623,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -11447,7 +11641,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -11469,7 +11663,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -11483,7 +11677,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11498,14 +11692,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -11526,7 +11720,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -11545,7 +11739,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -11568,7 +11762,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -11599,7 +11793,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -11613,7 +11807,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11628,14 +11822,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -11656,7 +11850,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -11675,7 +11869,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -11689,7 +11883,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -11711,7 +11905,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -11725,7 +11919,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11740,14 +11934,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -11768,7 +11962,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -11789,7 +11983,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -11808,7 +12002,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -11822,7 +12016,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -11853,7 +12047,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -11877,7 +12071,7 @@ "typeArguments": [ { "type": "reference", - "id": 877, + "id": 898, "name": "GenerateLinkResponse" } ], @@ -11932,7 +12126,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -12063,7 +12257,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -12112,10 +12306,10 @@ }, "type": { "type": "reference", - "id": 1048, + "id": 1069, "name": "PageParams", "dereferenced": { - "id": 1048, + "id": 1069, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -12130,14 +12324,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1070, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1071, "name": "page", "kind": 1024, "kindString": "Property", @@ -12160,7 +12354,7 @@ } }, { - "id": 1051, + "id": 1072, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -12187,7 +12381,7 @@ { "title": "Properties", "kind": 1024, - "children": [1050, 1051] + "children": [1071, 1072] } ], "sources": [ @@ -12278,7 +12472,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -12295,7 +12489,7 @@ }, { "type": "reference", - "id": 1041, + "id": 1062, "name": "Pagination" } ] @@ -12403,7 +12597,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -12546,7 +12740,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -12616,17 +12810,17 @@ }, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -12650,7 +12844,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -12674,7 +12868,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -12701,7 +12895,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -12725,7 +12919,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -12749,7 +12943,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -12777,7 +12971,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -12804,7 +12998,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -12828,7 +13022,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12855,7 +13049,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -12879,7 +13073,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -12903,7 +13097,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -12932,7 +13126,7 @@ "title": "Properties", "kind": 1024, "children": [ - 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + 728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727 ] } ], @@ -12949,7 +13143,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -12971,7 +13165,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -13024,7 +13218,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 182, + "line": 191, "character": 2 } ], @@ -13047,10 +13241,10 @@ "flags": {}, "type": { "type": "reference", - "id": 505, + "id": 526, "name": "GoTrueClientOptions", "dereferenced": { - "id": 505, + "id": 526, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -13065,14 +13259,14 @@ "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 535, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -13092,7 +13286,7 @@ } }, { - "id": 519, + "id": 540, "name": "debug", "kind": 1024, "kindString": "Property", @@ -13116,7 +13310,7 @@ { "type": "reflection", "declaration": { - "id": 520, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13130,14 +13324,14 @@ ], "signatures": [ { - "id": 521, + "id": 542, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 522, + "id": 543, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -13148,7 +13342,7 @@ } }, { - "id": 523, + "id": 544, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -13176,7 +13370,7 @@ } }, { - "id": 513, + "id": 534, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -13196,7 +13390,7 @@ } }, { - "id": 517, + "id": 538, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -13216,7 +13410,7 @@ } }, { - "id": 518, + "id": 539, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -13232,10 +13426,10 @@ ], "type": { "type": "reference", - "id": 779, + "id": 800, "name": "AuthFlowType", "dereferenced": { - "id": 779, + "id": 800, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -13264,7 +13458,7 @@ } }, { - "id": 525, + "id": 546, "name": "hasCustomAuthorizationHeader", "kind": 1024, "kindString": "Property", @@ -13293,7 +13487,7 @@ } }, { - "id": 508, + "id": 529, "name": "headers", "kind": 1024, "kindString": "Property", @@ -13310,7 +13504,7 @@ "type": { "type": "reflection", "declaration": { - "id": 509, + "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13323,14 +13517,14 @@ } ], "indexSignature": { - "id": 510, + "id": 531, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 511, + "id": 532, "name": "key", "kind": 32768, "flags": {}, @@ -13349,7 +13543,7 @@ } }, { - "id": 524, + "id": 545, "name": "lock", "kind": 1024, "kindString": "Property", @@ -13374,10 +13568,10 @@ ], "type": { "type": "reference", - "id": 496, + "id": 517, "name": "LockFunc", "dereferenced": { - "id": 496, + "id": 517, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -13392,7 +13586,7 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13406,7 +13600,7 @@ ], "signatures": [ { - "id": 498, + "id": 519, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -13422,7 +13616,7 @@ }, "typeParameter": [ { - "id": 504, + "id": 525, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -13431,7 +13625,7 @@ ], "parameters": [ { - "id": 499, + "id": 520, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -13445,7 +13639,7 @@ } }, { - "id": 500, + "id": 521, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -13459,7 +13653,7 @@ } }, { - "id": 501, + "id": 522, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -13470,7 +13664,7 @@ "type": { "type": "reflection", "declaration": { - "id": 502, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13484,7 +13678,7 @@ ], "signatures": [ { - "id": 503, + "id": 524, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -13494,7 +13688,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -13513,7 +13707,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -13529,7 +13723,7 @@ } }, { - "id": 515, + "id": 536, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -13549,7 +13743,7 @@ } }, { - "id": 516, + "id": 537, "name": "storage", "kind": 1024, "kindString": "Property", @@ -13565,10 +13759,10 @@ ], "type": { "type": "reference", - "id": 1028, + "id": 1049, "name": "SupportedStorage", "dereferenced": { - "id": 1028, + "id": 1049, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -13623,14 +13817,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1050, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1030, + "id": 1051, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -13657,7 +13851,7 @@ { "title": "Properties", "kind": 1024, - "children": [1030] + "children": [1051] } ], "sources": [ @@ -13675,7 +13869,7 @@ } }, { - "id": 512, + "id": 533, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -13695,7 +13889,7 @@ } }, { - "id": 507, + "id": 528, "name": "url", "kind": 1024, "kindString": "Property", @@ -13720,7 +13914,7 @@ "title": "Properties", "kind": 1024, "children": [ - 514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507 + 535, 540, 534, 538, 539, 546, 529, 545, 536, 537, 533, 528 ] } ], @@ -13757,7 +13951,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 132, + "line": 138, "character": 2 } ], @@ -14003,10 +14197,10 @@ ], "type": { "type": "reference", - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -14022,14 +14216,14 @@ }, "children": [ { - "id": 1025, + "id": 1046, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1026, + "id": 1047, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -14049,17 +14243,17 @@ }, "parameters": [ { - "id": 1027, + "id": 1048, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -14082,14 +14276,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -14110,7 +14304,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -14135,7 +14329,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -14156,7 +14350,7 @@ "typeArguments": [ { "type": "reference", - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -14168,14 +14362,14 @@ ] }, { - "id": 1022, + "id": 1043, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1023, + "id": 1044, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -14185,17 +14379,17 @@ }, "parameters": [ { - "id": 1024, + "id": 1045, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -14218,14 +14412,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -14250,7 +14444,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -14271,7 +14465,7 @@ "typeArguments": [ { "type": "reference", - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -14287,7 +14481,7 @@ { "title": "Methods", "kind": 2048, - "children": [1025, 1022] + "children": [1046, 1043] } ], "sources": [ @@ -14332,17 +14526,17 @@ "flags": {}, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -14366,7 +14560,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -14390,7 +14584,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -14417,7 +14611,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -14441,7 +14635,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -14465,7 +14659,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -14493,7 +14687,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -14520,7 +14714,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -14544,7 +14738,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -14571,7 +14765,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -14595,7 +14789,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -14619,7 +14813,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -14648,7 +14842,7 @@ "title": "Properties", "kind": 1024, "children": [ - 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + 728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727 ] } ], @@ -14665,7 +14859,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -14687,7 +14881,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -14757,7 +14951,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -14800,10 +14994,10 @@ "flags": {}, "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkParams", "dereferenced": { - "id": 876, + "id": 897, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14819,7 +15013,7 @@ "type": "union", "types": [ { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14834,14 +15028,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -14859,7 +15053,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -14878,7 +15072,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -14901,7 +15095,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -14919,7 +15113,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -14941,7 +15135,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -14955,7 +15149,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14970,14 +15164,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -14998,7 +15192,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -15017,7 +15211,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -15040,7 +15234,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -15071,7 +15265,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -15085,7 +15279,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15100,14 +15294,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -15128,7 +15322,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -15147,7 +15341,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -15161,7 +15355,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -15183,7 +15377,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -15197,7 +15391,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15212,14 +15406,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -15240,7 +15434,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -15261,7 +15455,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -15280,7 +15474,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -15294,7 +15488,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -15325,7 +15519,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -15349,7 +15543,7 @@ "typeArguments": [ { "type": "reference", - "id": 877, + "id": 898, "name": "GenerateLinkResponse" } ], @@ -15404,7 +15598,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -15535,7 +15729,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -15584,10 +15778,10 @@ }, "type": { "type": "reference", - "id": 1048, + "id": 1069, "name": "PageParams", "dereferenced": { - "id": 1048, + "id": 1069, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -15602,14 +15796,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1070, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1071, "name": "page", "kind": 1024, "kindString": "Property", @@ -15632,7 +15826,7 @@ } }, { - "id": 1051, + "id": 1072, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -15659,7 +15853,7 @@ { "title": "Properties", "kind": 1024, - "children": [1050, 1051] + "children": [1071, 1072] } ], "sources": [ @@ -15750,7 +15944,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -15767,7 +15961,7 @@ }, { "type": "reference", - "id": 1041, + "id": 1062, "name": "Pagination" } ] @@ -15875,7 +16069,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -16018,7 +16212,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -16088,17 +16282,17 @@ }, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -16122,7 +16316,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -16146,7 +16340,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -16173,7 +16367,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -16197,7 +16391,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -16221,7 +16415,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -16249,7 +16443,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -16276,7 +16470,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -16300,7 +16494,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16327,7 +16521,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -16351,7 +16545,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -16375,7 +16569,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -16404,7 +16598,7 @@ "title": "Properties", "kind": 1024, "children": [ - 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + 728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727 ] } ], @@ -16421,7 +16615,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -16443,7 +16637,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -16494,16 +16688,16 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 136, + "line": 142, "character": 2 } ], "type": { "type": "reference", - "id": 972, + "id": 993, "name": "GoTrueMFAApi", "dereferenced": { - "id": 972, + "id": 993, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -16513,14 +16707,14 @@ }, "children": [ { - "id": 980, + "id": 1001, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 1002, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -16530,17 +16724,17 @@ }, "parameters": [ { - "id": 982, + "id": 1003, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 907, + "id": 928, "name": "MFAChallengeParams", "dereferenced": { - "id": 907, + "id": 928, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -16555,14 +16749,14 @@ "type": { "type": "reflection", "declaration": { - "id": 908, + "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 910, + "id": 931, "name": "channel", "kind": 1024, "kindString": "Property", @@ -16594,7 +16788,7 @@ } }, { - "id": 909, + "id": 930, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -16619,7 +16813,7 @@ { "title": "Properties", "kind": 1024, - "children": [910, 909] + "children": [931, 930] } ], "sources": [ @@ -16640,7 +16834,7 @@ "typeArguments": [ { "type": "reference", - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse" } ], @@ -16652,14 +16846,14 @@ ] }, { - "id": 989, + "id": 1010, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 990, + "id": 1011, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -16669,17 +16863,17 @@ }, "parameters": [ { - "id": 991, + "id": 1012, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -16694,14 +16888,14 @@ "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 933, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 914, + "id": 935, "name": "code", "kind": 1024, "kindString": "Property", @@ -16722,7 +16916,7 @@ } }, { - "id": 913, + "id": 934, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -16747,7 +16941,7 @@ { "title": "Properties", "kind": 1024, - "children": [914, 913] + "children": [935, 934] } ], "sources": [ @@ -16768,7 +16962,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -16780,14 +16974,14 @@ ] }, { - "id": 973, + "id": 994, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 974, + "id": 995, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -16798,17 +16992,17 @@ }, "parameters": [ { - "id": 975, + "id": 996, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -16823,14 +17017,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -16851,7 +17045,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -16874,7 +17068,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -16901,7 +17095,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -16922,7 +17116,7 @@ "typeArguments": [ { "type": "reference", - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse" } ], @@ -16932,24 +17126,24 @@ } }, { - "id": 976, + "id": 997, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 977, + "id": 998, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -16964,14 +17158,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -16992,7 +17186,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17015,7 +17209,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -17040,7 +17234,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -17061,7 +17255,7 @@ "typeArguments": [ { "type": "reference", - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse" } ], @@ -17071,24 +17265,24 @@ } }, { - "id": 978, + "id": 999, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 979, + "id": 1000, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 898, + "id": 919, "name": "MFAEnrollParams", "dereferenced": { - "id": 898, + "id": 919, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -17104,7 +17298,7 @@ "type": "union", "types": [ { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -17119,14 +17313,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -17147,7 +17341,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17170,7 +17364,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -17197,7 +17391,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -17211,7 +17405,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -17226,14 +17420,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -17254,7 +17448,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17277,7 +17471,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -17302,7 +17496,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -17326,7 +17520,7 @@ "typeArguments": [ { "type": "reference", - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse" } ], @@ -17338,14 +17532,14 @@ ] }, { - "id": 994, + "id": 1015, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 995, + "id": 1016, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -17359,7 +17553,7 @@ "typeArguments": [ { "type": "reference", - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -17371,14 +17565,14 @@ ] }, { - "id": 992, + "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 993, + "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -17405,7 +17599,7 @@ "typeArguments": [ { "type": "reference", - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse" } ], @@ -17417,14 +17611,14 @@ ] }, { - "id": 986, + "id": 1007, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 987, + "id": 1008, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -17434,17 +17628,17 @@ }, "parameters": [ { - "id": 988, + "id": 1009, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "dereferenced": { - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -17459,14 +17653,14 @@ "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 922, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17491,7 +17685,7 @@ { "title": "Properties", "kind": 1024, - "children": [901] + "children": [922] } ], "sources": [ @@ -17512,7 +17706,7 @@ "typeArguments": [ { "type": "reference", - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse" } ], @@ -17524,14 +17718,14 @@ ] }, { - "id": 983, + "id": 1004, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 1005, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -17541,17 +17735,17 @@ }, "parameters": [ { - "id": 985, + "id": 1006, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 902, + "id": 923, "name": "MFAVerifyParams", "dereferenced": { - "id": 902, + "id": 923, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17566,14 +17760,14 @@ "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 924, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 926, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -17594,7 +17788,7 @@ } }, { - "id": 906, + "id": 927, "name": "code", "kind": 1024, "kindString": "Property", @@ -17615,7 +17809,7 @@ } }, { - "id": 904, + "id": 925, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17640,7 +17834,7 @@ { "title": "Properties", "kind": 1024, - "children": [905, 906, 904] + "children": [926, 927, 925] } ], "sources": [ @@ -17661,7 +17855,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -17677,7 +17871,7 @@ { "title": "Methods", "kind": 2048, - "children": [980, 989, 973, 994, 992, 986, 983] + "children": [1001, 1010, 994, 1015, 1013, 1007, 1004] } ], "sources": [ @@ -17691,7 +17885,7 @@ } }, { - "id": 144, + "id": 147, "name": "exchangeCodeForSession", "kind": 2048, "kindString": "Method", @@ -17699,13 +17893,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 584, + "line": 593, "character": 8 } ], "signatures": [ { - "id": 145, + "id": 148, "name": "exchangeCodeForSession", "kind": 4096, "kindString": "Call signature", @@ -17715,7 +17909,7 @@ }, "parameters": [ { - "id": 146, + "id": 149, "name": "authCode", "kind": 32768, "kindString": "Parameter", @@ -17731,7 +17925,7 @@ "typeArguments": [ { "type": "reference", - "id": 574, + "id": 595, "name": "AuthTokenResponse" } ], @@ -17743,7 +17937,358 @@ ] }, { - "id": 183, + "id": 477, + "name": "getClaims", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2636, + "character": 8 + } + ], + "signatures": [ + { + "id": 478, + "name": "getClaims", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "experimental", + "text": "This method may change in future versions." + }, + { + "tag": "description", + "text": "Gets the claims from a JWT. If the JWT is symmetric JWTs, it will call getUser() to verify against the server. If the JWT is asymmetric, it will be verified against the JWKS using the WebCrypto API.\n" + } + ] + }, + "parameters": [ + { + "id": 479, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 480, + "name": "jwks", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 481, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 482, + "name": "keys", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2638, + "character": 12 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 1133, + "name": "JWK" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [482] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 484, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 485, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "claims", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 1129, + "name": "JwtPayload" + } + }, + { + "id": 487, + "name": "header", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 36 + } + ], + "type": { + "type": "reference", + "id": 1114, + "name": "JwtHeader" + } + }, + { + "id": 488, + "name": "signature", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 55 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Uint8Array", + "package": "typescript", + "name": "Uint8Array" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [486, 487, 488] + } + ] + } + } + }, + { + "id": 489, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2642, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [484, 489] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 490, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 491, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2644, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 492, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2644, + "character": 20 + } + ], + "type": { + "type": "reference", + "id": 1158, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [491, 492] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 493, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 494, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2645, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 495, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2645, + "character": 20 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [494, 495] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 186, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -17751,13 +18296,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 935, + "line": 944, "character": 8 } ], "signatures": [ { - "id": 184, + "id": 187, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -17775,158 +18320,18 @@ { "type": "reflection", "declaration": { - "id": 185, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ - { - "id": 186, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1028, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 188, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1029, - "character": 14 - } - ], - "type": { - "type": "reference", - "id": 635, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [188] - } - ] - } - } - }, { "id": 189, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1031, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186, 189] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 191, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1034, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1035, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [193] - } - ] - } - } - }, - { - "id": 194, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -17934,55 +18339,17 @@ "character": 12 } ], - "type": { - "type": "reference", - "id": 1111, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [191, 194] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 195, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 196, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1040, - "character": 12 - } - ], "type": { "type": "reflection", "declaration": { - "id": 197, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 191, "name": "session", "kind": 1024, "kindString": "Property", @@ -17990,13 +18357,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1041, + "line": 1038, "character": 14 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 656, + "name": "Session" } } ], @@ -18004,14 +18372,14 @@ { "title": "Properties", "kind": 1024, - "children": [198] + "children": [191] } ] } } }, { - "id": 199, + "id": 192, "name": "error", "kind": 1024, "kindString": "Property", @@ -18019,7 +18387,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1043, + "line": 1040, "character": 12 } ], @@ -18033,7 +18401,184 @@ { "title": "Properties", "kind": 1024, - "children": [196, 199] + "children": [189, 192] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 193, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 194, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1043, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 195, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 196, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1044, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [196] + } + ] + } + } + }, + { + "id": 197, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1046, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 1158, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [194, 197] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 198, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 199, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1049, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 200, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 201, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1050, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [201] + } + ] + } + } + }, + { + "id": 202, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1052, + "character": 12 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [199, 202] } ] } @@ -18049,7 +18594,7 @@ ] }, { - "id": 246, + "id": 249, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -18057,13 +18602,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1166, + "line": 1175, "character": 8 } ], "signatures": [ { - "id": 247, + "id": 250, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -18073,7 +18618,7 @@ }, "parameters": [ { - "id": 248, + "id": 251, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -18094,7 +18639,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -18106,7 +18651,7 @@ ] }, { - "id": 362, + "id": 358, "name": "getUserIdentities", "kind": 2048, "kindString": "Method", @@ -18114,13 +18659,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1735, + "line": 1733, "character": 8 } ], "signatures": [ { - "id": 363, + "id": 359, "name": "getUserIdentities", "kind": 4096, "kindString": "Call signature", @@ -18137,14 +18682,14 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 361, "name": "data", "kind": 1024, "kindString": "Property", @@ -18152,21 +18697,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1737, + "line": 1735, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 366, + "id": 362, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 367, + "id": 363, "name": "identities", "kind": 1024, "kindString": "Property", @@ -18174,7 +18719,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1738, + "line": 1736, "character": 10 } ], @@ -18182,7 +18727,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } @@ -18192,18 +18737,55 @@ { "title": "Properties", "kind": 1024, - "children": [367] + "children": [363] } ] } } }, { - "id": 368, + "id": 364, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1738, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [361, 364] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 365, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 366, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -18215,46 +18797,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 368] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 370, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1742, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 371, + "id": 367, "name": "error", "kind": 1024, "kindString": "Property", @@ -18262,13 +18807,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1742, + "line": 1740, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -18277,7 +18822,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [366, 367] } ] } @@ -18293,7 +18838,7 @@ ] }, { - "id": 128, + "id": 131, "name": "initialize", "kind": 2048, "kindString": "Method", @@ -18301,13 +18846,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 286, + "line": 295, "character": 8 } ], "signatures": [ { - "id": 129, + "id": 132, "name": "initialize", "kind": 4096, "kindString": "Call signature", @@ -18320,7 +18865,7 @@ "typeArguments": [ { "type": "reference", - "id": 1031, + "id": 1052, "name": "InitializeResult" } ], @@ -18332,7 +18877,7 @@ ] }, { - "id": 372, + "id": 368, "name": "linkIdentity", "kind": 2048, "kindString": "Method", @@ -18340,13 +18885,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1759, + "line": 1757, "character": 8 } ], "signatures": [ { - "id": 373, + "id": 369, "name": "linkIdentity", "kind": 4096, "kindString": "Call signature", @@ -18356,17 +18901,17 @@ }, "parameters": [ { - "id": 374, + "id": 370, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -18381,14 +18926,14 @@ "type": { "type": "reflection", "declaration": { - "id": 781, + "id": 802, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 783, + "id": 804, "name": "options", "kind": 1024, "kindString": "Property", @@ -18405,14 +18950,14 @@ "type": { "type": "reflection", "declaration": { - "id": 784, + "id": 805, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 787, + "id": 808, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -18432,7 +18977,7 @@ "type": { "type": "reflection", "declaration": { - "id": 788, + "id": 809, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -18445,14 +18990,14 @@ } ], "indexSignature": { - "id": 789, + "id": 810, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 790, + "id": 811, "name": "key", "kind": 32768, "flags": {}, @@ -18471,7 +19016,7 @@ } }, { - "id": 785, + "id": 806, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -18494,7 +19039,7 @@ } }, { - "id": 786, + "id": 807, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -18517,7 +19062,7 @@ } }, { - "id": 791, + "id": 812, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -18544,7 +19089,7 @@ { "title": "Properties", "kind": 1024, - "children": [787, 785, 786, 791] + "children": [808, 806, 807, 812] } ], "sources": [ @@ -18558,7 +19103,7 @@ } }, { - "id": 782, + "id": 803, "name": "provider", "kind": 1024, "kindString": "Property", @@ -18575,10 +19120,10 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider", "dereferenced": { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -18694,7 +19239,7 @@ { "title": "Properties", "kind": 1024, - "children": [783, 782] + "children": [804, 803] } ], "sources": [ @@ -18715,7 +19260,7 @@ "typeArguments": [ { "type": "reference", - "id": 602, + "id": 623, "name": "OAuthResponse" } ], @@ -18727,7 +19272,7 @@ ] }, { - "id": 334, + "id": 330, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -18735,13 +19280,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1633, + "line": 1631, "character": 2 } ], "signatures": [ { - "id": 335, + "id": 331, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -18751,7 +19296,7 @@ }, "parameters": [ { - "id": 336, + "id": 332, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -18762,33 +19307,33 @@ "type": { "type": "reflection", "declaration": { - "id": 337, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 338, + "id": 334, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 339, + "id": 335, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent" } }, { - "id": 340, + "id": 336, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -18802,7 +19347,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -18839,14 +19384,14 @@ "type": { "type": "reflection", "declaration": { - "id": 341, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 338, "name": "data", "kind": 1024, "kindString": "Property", @@ -18854,21 +19399,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1636, + "line": 1634, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 343, + "id": 339, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 344, + "id": 340, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -18876,23 +19421,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1636, + "line": 1634, "character": 12 } ], "type": { "type": "reference", - "id": 718, + "id": 739, "name": "Subscription", "dereferenced": { - "id": 718, + "id": 739, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 719, + "id": 740, "name": "id", "kind": 1024, "kindString": "Property", @@ -18913,7 +19458,7 @@ } }, { - "id": 720, + "id": 741, "name": "callback", "kind": 2048, "kindString": "Method", @@ -18927,7 +19472,7 @@ ], "signatures": [ { - "id": 721, + "id": 742, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -18937,17 +19482,17 @@ }, "parameters": [ { - "id": 722, + "id": 743, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent", "dereferenced": { - "id": 495, + "id": 516, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -18987,7 +19532,7 @@ "value": "USER_UPDATED" }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -19010,7 +19555,7 @@ } }, { - "id": 723, + "id": 744, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -19024,7 +19569,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -19039,7 +19584,7 @@ ] }, { - "id": 724, + "id": 745, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -19053,7 +19598,7 @@ ], "signatures": [ { - "id": 725, + "id": 746, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -19073,12 +19618,12 @@ { "title": "Properties", "kind": 1024, - "children": [719] + "children": [740] }, { "title": "Methods", "kind": 2048, - "children": [720, 724] + "children": [741, 745] } ], "sources": [ @@ -19096,7 +19641,7 @@ { "title": "Properties", "kind": 1024, - "children": [344] + "children": [340] } ] } @@ -19107,7 +19652,7 @@ { "title": "Properties", "kind": 1024, - "children": [342] + "children": [338] } ] } @@ -19116,7 +19661,7 @@ ] }, { - "id": 176, + "id": 179, "name": "reauthenticate", "kind": 2048, "kindString": "Method", @@ -19124,13 +19669,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 851, + "line": 860, "character": 8 } ], "signatures": [ { - "id": 177, + "id": 180, "name": "reauthenticate", "kind": 4096, "kindString": "Call signature", @@ -19143,7 +19688,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -19155,7 +19700,7 @@ ] }, { - "id": 283, + "id": 279, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -19163,13 +19708,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1382, + "line": 1380, "character": 8 } ], "signatures": [ { - "id": 284, + "id": 280, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -19179,7 +19724,7 @@ }, "parameters": [ { - "id": 285, + "id": 281, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -19192,14 +19737,14 @@ "type": { "type": "reflection", "declaration": { - "id": 286, + "id": 282, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 283, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -19207,7 +19752,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1382, + "line": 1380, "character": 42 } ], @@ -19221,7 +19766,7 @@ { "title": "Properties", "kind": 1024, - "children": [287] + "children": [283] } ] } @@ -19233,7 +19778,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -19245,7 +19790,7 @@ ] }, { - "id": 180, + "id": 183, "name": "resend", "kind": 2048, "kindString": "Method", @@ -19253,13 +19798,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 886, + "line": 895, "character": 8 } ], "signatures": [ { - "id": 181, + "id": 184, "name": "resend", "kind": 4096, "kindString": "Call signature", @@ -19269,17 +19814,17 @@ }, "parameters": [ { - "id": 182, + "id": 185, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 824, + "id": 845, "name": "ResendParams", "dereferenced": { - "id": 824, + "id": 845, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -19297,14 +19842,14 @@ { "type": "reflection", "declaration": { - "id": 825, + "id": 846, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 827, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", @@ -19322,7 +19867,7 @@ } }, { - "id": 828, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -19339,14 +19884,14 @@ "type": { "type": "reflection", "declaration": { - "id": 829, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 831, + "id": 852, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19369,7 +19914,7 @@ } }, { - "id": 830, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -19396,7 +19941,7 @@ { "title": "Properties", "kind": 1024, - "children": [831, 830] + "children": [852, 851] } ], "sources": [ @@ -19410,7 +19955,7 @@ } }, { - "id": 826, + "id": 847, "name": "type", "kind": 1024, "kindString": "Property", @@ -19427,7 +19972,7 @@ "typeArguments": [ { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType" }, { @@ -19454,7 +19999,7 @@ { "title": "Properties", "kind": 1024, - "children": [827, 828, 826] + "children": [848, 849, 847] } ], "sources": [ @@ -19469,14 +20014,14 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 853, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -19493,14 +20038,14 @@ "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 857, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 858, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19527,7 +20072,7 @@ { "title": "Properties", "kind": 1024, - "children": [837] + "children": [858] } ], "sources": [ @@ -19541,7 +20086,7 @@ } }, { - "id": 834, + "id": 855, "name": "phone", "kind": 1024, "kindString": "Property", @@ -19559,7 +20104,7 @@ } }, { - "id": 833, + "id": 854, "name": "type", "kind": 1024, "kindString": "Property", @@ -19576,7 +20121,7 @@ "typeArguments": [ { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType" }, { @@ -19603,7 +20148,7 @@ { "title": "Properties", "kind": 1024, - "children": [835, 834, 833] + "children": [856, 855, 854] } ], "sources": [ @@ -19626,7 +20171,7 @@ "typeArguments": [ { "type": "reference", - "id": 559, + "id": 580, "name": "AuthOtpResponse" } ], @@ -19638,7 +20183,7 @@ ] }, { - "id": 348, + "id": 344, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -19646,13 +20191,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1689, + "line": 1687, "character": 8 } ], "signatures": [ { - "id": 349, + "id": 345, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -19662,7 +20207,7 @@ }, "parameters": [ { - "id": 350, + "id": 346, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -19676,7 +20221,7 @@ } }, { - "id": 351, + "id": 347, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -19684,14 +20229,14 @@ "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 350, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19704,7 +20249,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1693, + "line": 1691, "character": 6 } ], @@ -19714,7 +20259,7 @@ } }, { - "id": 353, + "id": 349, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19727,7 +20272,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1692, + "line": 1690, "character": 6 } ], @@ -19741,7 +20286,7 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [350, 349] } ] } @@ -19755,6 +20300,67 @@ { "type": "union", "types": [ + { + "type": "reflection", + "declaration": { + "id": 351, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 352, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1695, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 353, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 354, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1696, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [352, 354] + } + ] + } + }, { "type": "reflection", "declaration": { @@ -19770,30 +20376,6 @@ "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1697, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 357, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 358, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -19805,46 +20387,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [356, 358] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1700, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 361, + "id": 357, "name": "error", "kind": 1024, "kindString": "Property", @@ -19852,13 +20397,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1700, + "line": 1698, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -19867,7 +20412,7 @@ { "title": "Properties", "kind": 1024, - "children": [360, 361] + "children": [356, 357] } ] } @@ -19883,7 +20428,7 @@ ] }, { - "id": 271, + "id": 267, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -19891,13 +20436,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1307, + "line": 1305, "character": 8 } ], "signatures": [ { - "id": 272, + "id": 268, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -19907,7 +20452,7 @@ }, "parameters": [ { - "id": 273, + "id": 269, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -19918,14 +20463,14 @@ "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 275, + "id": 271, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -19933,7 +20478,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1308, + "line": 1306, "character": 4 } ], @@ -19943,7 +20488,7 @@ } }, { - "id": 276, + "id": 272, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -19951,7 +20496,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1309, + "line": 1307, "character": 4 } ], @@ -19965,7 +20510,7 @@ { "title": "Properties", "kind": 1024, - "children": [275, 276] + "children": [271, 272] } ] } @@ -19977,7 +20522,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -19989,7 +20534,7 @@ ] }, { - "id": 132, + "id": 135, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", @@ -19997,13 +20542,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 389, + "line": 398, "character": 8 } ], "signatures": [ { - "id": 133, + "id": 136, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", @@ -20014,7 +20559,7 @@ }, "parameters": [ { - "id": 134, + "id": 137, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -20023,10 +20568,10 @@ }, "type": { "type": "reference", - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials", "dereferenced": { - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20041,14 +20586,14 @@ "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 748, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 728, + "id": 749, "name": "options", "kind": 1024, "kindString": "Property", @@ -20065,14 +20610,14 @@ "type": { "type": "reflection", "declaration": { - "id": 729, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 752, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20095,7 +20640,7 @@ } }, { - "id": 730, + "id": 751, "name": "data", "kind": 1024, "kindString": "Property", @@ -20123,7 +20668,7 @@ { "title": "Properties", "kind": 1024, - "children": [731, 730] + "children": [752, 751] } ], "sources": [ @@ -20141,7 +20686,7 @@ { "title": "Properties", "kind": 1024, - "children": [728] + "children": [749] } ], "sources": [ @@ -20162,7 +20707,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -20174,7 +20719,7 @@ ] }, { - "id": 164, + "id": 167, "name": "signInWithIdToken", "kind": 2048, "kindString": "Method", @@ -20182,13 +20727,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 644, + "line": 653, "character": 8 } ], "signatures": [ { - "id": 165, + "id": 168, "name": "signInWithIdToken", "kind": 4096, "kindString": "Call signature", @@ -20198,17 +20743,17 @@ }, "parameters": [ { - "id": 166, + "id": 169, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 792, + "id": 813, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 792, + "id": 813, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20223,14 +20768,14 @@ "type": { "type": "reflection", "declaration": { - "id": 793, + "id": 814, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -20253,7 +20798,7 @@ } }, { - "id": 798, + "id": 819, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -20276,7 +20821,7 @@ } }, { - "id": 799, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -20293,14 +20838,14 @@ "type": { "type": "reflection", "declaration": { - "id": 800, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 801, + "id": 822, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20327,7 +20872,7 @@ { "title": "Properties", "kind": 1024, - "children": [801] + "children": [822] } ], "sources": [ @@ -20341,7 +20886,7 @@ } }, { - "id": 794, + "id": 815, "name": "provider", "kind": 1024, "kindString": "Property", @@ -20389,7 +20934,7 @@ { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -20409,7 +20954,7 @@ } }, { - "id": 796, + "id": 817, "name": "token", "kind": 1024, "kindString": "Property", @@ -20434,7 +20979,7 @@ { "title": "Properties", "kind": 1024, - "children": [797, 798, 799, 794, 796] + "children": [818, 819, 820, 815, 817] } ], "sources": [ @@ -20455,7 +21000,7 @@ "typeArguments": [ { "type": "reference", - "id": 574, + "id": 595, "name": "AuthTokenResponse" } ], @@ -20467,7 +21012,7 @@ ] }, { - "id": 141, + "id": 144, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -20475,13 +21020,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 572, + "line": 581, "character": 8 } ], "signatures": [ { - "id": 142, + "id": 145, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -20491,17 +21036,17 @@ }, "parameters": [ { - "id": 143, + "id": 146, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20516,14 +21061,14 @@ "type": { "type": "reflection", "declaration": { - "id": 781, + "id": 802, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 783, + "id": 804, "name": "options", "kind": 1024, "kindString": "Property", @@ -20540,14 +21085,14 @@ "type": { "type": "reflection", "declaration": { - "id": 784, + "id": 805, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 787, + "id": 808, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -20567,7 +21112,7 @@ "type": { "type": "reflection", "declaration": { - "id": 788, + "id": 809, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -20580,14 +21125,14 @@ } ], "indexSignature": { - "id": 789, + "id": 810, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 790, + "id": 811, "name": "key", "kind": 32768, "flags": {}, @@ -20606,7 +21151,7 @@ } }, { - "id": 785, + "id": 806, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -20629,7 +21174,7 @@ } }, { - "id": 786, + "id": 807, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -20652,7 +21197,7 @@ } }, { - "id": 791, + "id": 812, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -20679,7 +21224,7 @@ { "title": "Properties", "kind": 1024, - "children": [787, 785, 786, 791] + "children": [808, 806, 807, 812] } ], "sources": [ @@ -20693,7 +21238,7 @@ } }, { - "id": 782, + "id": 803, "name": "provider", "kind": 1024, "kindString": "Property", @@ -20710,10 +21255,10 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider", "dereferenced": { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -20829,7 +21374,7 @@ { "title": "Properties", "kind": 1024, - "children": [783, 782] + "children": [804, 803] } ], "sources": [ @@ -20850,7 +21395,7 @@ "typeArguments": [ { "type": "reference", - "id": 602, + "id": 623, "name": "OAuthResponse" } ], @@ -20862,7 +21407,7 @@ ] }, { - "id": 167, + "id": 170, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -20870,13 +21415,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 699, + "line": 708, "character": 8 } ], "signatures": [ { - "id": 168, + "id": 171, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -20887,17 +21432,17 @@ }, "parameters": [ { - "id": 169, + "id": 172, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 762, + "id": 783, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 762, + "id": 783, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20915,14 +21460,14 @@ { "type": "reflection", "declaration": { - "id": 763, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 764, + "id": 785, "name": "email", "kind": 1024, "kindString": "Property", @@ -20943,7 +21488,7 @@ } }, { - "id": 765, + "id": 786, "name": "options", "kind": 1024, "kindString": "Property", @@ -20960,14 +21505,14 @@ "type": { "type": "reflection", "declaration": { - "id": 766, + "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 770, + "id": 791, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20990,7 +21535,7 @@ } }, { - "id": 769, + "id": 790, "name": "data", "kind": 1024, "kindString": "Property", @@ -21014,7 +21559,7 @@ } }, { - "id": 767, + "id": 788, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -21037,7 +21582,7 @@ } }, { - "id": 768, + "id": 789, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -21064,7 +21609,7 @@ { "title": "Properties", "kind": 1024, - "children": [770, 769, 767, 768] + "children": [791, 790, 788, 789] } ], "sources": [ @@ -21082,7 +21627,7 @@ { "title": "Properties", "kind": 1024, - "children": [764, 765] + "children": [785, 786] } ], "sources": [ @@ -21097,14 +21642,14 @@ { "type": "reflection", "declaration": { - "id": 771, + "id": 792, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 773, + "id": 794, "name": "options", "kind": 1024, "kindString": "Property", @@ -21121,14 +21666,14 @@ "type": { "type": "reflection", "declaration": { - "id": 774, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 777, + "id": 798, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21151,7 +21696,7 @@ } }, { - "id": 778, + "id": 799, "name": "channel", "kind": 1024, "kindString": "Property", @@ -21183,7 +21728,7 @@ } }, { - "id": 776, + "id": 797, "name": "data", "kind": 1024, "kindString": "Property", @@ -21207,7 +21752,7 @@ } }, { - "id": 775, + "id": 796, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -21234,7 +21779,7 @@ { "title": "Properties", "kind": 1024, - "children": [777, 778, 776, 775] + "children": [798, 799, 797, 796] } ], "sources": [ @@ -21248,7 +21793,7 @@ } }, { - "id": 772, + "id": 793, "name": "phone", "kind": 1024, "kindString": "Property", @@ -21273,7 +21818,7 @@ { "title": "Properties", "kind": 1024, - "children": [773, 772] + "children": [794, 793] } ], "sources": [ @@ -21296,7 +21841,7 @@ "typeArguments": [ { "type": "reference", - "id": 559, + "id": 580, "name": "AuthOtpResponse" } ], @@ -21308,7 +21853,7 @@ ] }, { - "id": 138, + "id": 141, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -21316,13 +21861,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 509, + "line": 518, "character": 8 } ], "signatures": [ { - "id": 139, + "id": 142, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -21333,17 +21878,17 @@ }, "parameters": [ { - "id": 140, + "id": 143, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -21361,14 +21906,14 @@ { "type": "reflection", "declaration": { - "id": 750, + "id": 771, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 751, + "id": 772, "name": "email", "kind": 1024, "kindString": "Property", @@ -21389,7 +21934,7 @@ } }, { - "id": 753, + "id": 774, "name": "options", "kind": 1024, "kindString": "Property", @@ -21406,14 +21951,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 775, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 755, + "id": 776, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21440,7 +21985,7 @@ { "title": "Properties", "kind": 1024, - "children": [755] + "children": [776] } ], "sources": [ @@ -21454,7 +21999,7 @@ } }, { - "id": 752, + "id": 773, "name": "password", "kind": 1024, "kindString": "Property", @@ -21479,7 +22024,7 @@ { "title": "Properties", "kind": 1024, - "children": [751, 753, 752] + "children": [772, 774, 773] } ], "sources": [ @@ -21494,14 +22039,14 @@ { "type": "reflection", "declaration": { - "id": 756, + "id": 777, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 759, + "id": 780, "name": "options", "kind": 1024, "kindString": "Property", @@ -21518,14 +22063,14 @@ "type": { "type": "reflection", "declaration": { - "id": 760, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 782, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21552,7 +22097,7 @@ { "title": "Properties", "kind": 1024, - "children": [761] + "children": [782] } ], "sources": [ @@ -21566,7 +22111,7 @@ } }, { - "id": 758, + "id": 779, "name": "password", "kind": 1024, "kindString": "Property", @@ -21587,7 +22132,7 @@ } }, { - "id": 757, + "id": 778, "name": "phone", "kind": 1024, "kindString": "Property", @@ -21612,7 +22157,7 @@ { "title": "Properties", "kind": 1024, - "children": [759, 758, 757] + "children": [780, 779, 778] } ], "sources": [ @@ -21635,7 +22180,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 608, "name": "AuthTokenResponsePassword" } ], @@ -21647,7 +22192,7 @@ ] }, { - "id": 173, + "id": 176, "name": "signInWithSSO", "kind": 2048, "kindString": "Method", @@ -21655,13 +22200,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 813, + "line": 822, "character": 8 } ], "signatures": [ { - "id": 174, + "id": 177, "name": "signInWithSSO", "kind": 4096, "kindString": "Call signature", @@ -21672,17 +22217,17 @@ }, "parameters": [ { - "id": 175, + "id": 178, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 838, + "id": 859, "name": "SignInWithSSO", "dereferenced": { - "id": 838, + "id": 859, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -21700,14 +22245,14 @@ { "type": "reflection", "declaration": { - "id": 839, + "id": 860, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 862, "name": "options", "kind": 1024, "kindString": "Property", @@ -21724,14 +22269,14 @@ "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21754,7 +22299,7 @@ } }, { - "id": 843, + "id": 864, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -21781,7 +22326,7 @@ { "title": "Properties", "kind": 1024, - "children": [844, 843] + "children": [865, 864] } ], "sources": [ @@ -21795,7 +22340,7 @@ } }, { - "id": 840, + "id": 861, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -21820,7 +22365,7 @@ { "title": "Properties", "kind": 1024, - "children": [841, 840] + "children": [862, 861] } ], "sources": [ @@ -21835,14 +22380,14 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 866, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 867, "name": "domain", "kind": 1024, "kindString": "Property", @@ -21863,7 +22408,7 @@ } }, { - "id": 847, + "id": 868, "name": "options", "kind": 1024, "kindString": "Property", @@ -21880,14 +22425,14 @@ "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 869, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 850, + "id": 871, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21910,7 +22455,7 @@ } }, { - "id": 849, + "id": 870, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -21937,7 +22482,7 @@ { "title": "Properties", "kind": 1024, - "children": [850, 849] + "children": [871, 870] } ], "sources": [ @@ -21955,7 +22500,7 @@ { "title": "Properties", "kind": 1024, - "children": [846, 847] + "children": [867, 868] } ], "sources": [ @@ -21978,7 +22523,7 @@ "typeArguments": [ { "type": "reference", - "id": 615, + "id": 636, "name": "SSOResponse" } ], @@ -21990,7 +22535,7 @@ ] }, { - "id": 324, + "id": 320, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -21998,13 +22543,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1589, + "line": 1587, "character": 8 } ], "signatures": [ { - "id": 325, + "id": 321, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -22015,17 +22560,17 @@ }, "parameters": [ { - "id": 326, + "id": 322, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1052, + "id": 1073, "name": "SignOut", "dereferenced": { - "id": 1052, + "id": 1073, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -22040,14 +22585,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1053, + "id": 1074, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1054, + "id": 1075, "name": "scope", "kind": 1024, "kindString": "Property", @@ -22087,7 +22632,7 @@ { "title": "Properties", "kind": 1024, - "children": [1054] + "children": [1075] } ], "sources": [ @@ -22110,14 +22655,14 @@ { "type": "reflection", "declaration": { - "id": 327, + "id": 323, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 328, + "id": 324, "name": "error", "kind": 1024, "kindString": "Property", @@ -22125,7 +22670,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1589, + "line": 1587, "character": 67 } ], @@ -22138,7 +22683,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -22149,7 +22694,7 @@ { "title": "Properties", "kind": 1024, - "children": [328] + "children": [324] } ] } @@ -22163,7 +22708,7 @@ ] }, { - "id": 135, + "id": 138, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -22171,13 +22716,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 432, + "line": 441, "character": 8 } ], "signatures": [ { - "id": 136, + "id": 139, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -22189,17 +22734,17 @@ }, "parameters": [ { - "id": 137, + "id": 140, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -22217,14 +22762,14 @@ { "type": "reflection", "declaration": { - "id": 733, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 734, + "id": 755, "name": "email", "kind": 1024, "kindString": "Property", @@ -22245,7 +22790,7 @@ } }, { - "id": 736, + "id": 757, "name": "options", "kind": 1024, "kindString": "Property", @@ -22262,14 +22807,14 @@ "type": { "type": "reflection", "declaration": { - "id": 737, + "id": 758, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 740, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22292,7 +22837,7 @@ } }, { - "id": 739, + "id": 760, "name": "data", "kind": 1024, "kindString": "Property", @@ -22316,7 +22861,7 @@ } }, { - "id": 738, + "id": 759, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -22343,7 +22888,7 @@ { "title": "Properties", "kind": 1024, - "children": [740, 739, 738] + "children": [761, 760, 759] } ], "sources": [ @@ -22357,7 +22902,7 @@ } }, { - "id": 735, + "id": 756, "name": "password", "kind": 1024, "kindString": "Property", @@ -22382,7 +22927,7 @@ { "title": "Properties", "kind": 1024, - "children": [734, 736, 735] + "children": [755, 757, 756] } ], "sources": [ @@ -22397,14 +22942,14 @@ { "type": "reflection", "declaration": { - "id": 741, + "id": 762, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -22421,14 +22966,14 @@ "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 747, + "id": 768, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22451,7 +22996,7 @@ } }, { - "id": 748, + "id": 769, "name": "channel", "kind": 1024, "kindString": "Property", @@ -22483,7 +23028,7 @@ } }, { - "id": 746, + "id": 767, "name": "data", "kind": 1024, "kindString": "Property", @@ -22511,7 +23056,7 @@ { "title": "Properties", "kind": 1024, - "children": [747, 748, 746] + "children": [768, 769, 767] } ], "sources": [ @@ -22525,7 +23070,7 @@ } }, { - "id": 743, + "id": 764, "name": "password", "kind": 1024, "kindString": "Property", @@ -22546,7 +23091,7 @@ } }, { - "id": 742, + "id": 763, "name": "phone", "kind": 1024, "kindString": "Property", @@ -22571,7 +23116,7 @@ { "title": "Properties", "kind": 1024, - "children": [744, 743, 742] + "children": [765, 764, 763] } ], "sources": [ @@ -22594,7 +23139,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -22606,7 +23151,7 @@ ] }, { - "id": 430, + "id": 426, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -22614,13 +23159,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2174, + "line": 2172, "character": 8 } ], "signatures": [ { - "id": 431, + "id": 427, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -22645,7 +23190,7 @@ ] }, { - "id": 432, + "id": 428, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -22653,13 +23198,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2187, + "line": 2185, "character": 8 } ], "signatures": [ { - "id": 433, + "id": 429, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -22684,7 +23229,7 @@ ] }, { - "id": 375, + "id": 371, "name": "unlinkIdentity", "kind": 2048, "kindString": "Method", @@ -22692,13 +23237,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1795, + "line": 1793, "character": 8 } ], "signatures": [ { - "id": 376, + "id": 372, "name": "unlinkIdentity", "kind": 4096, "kindString": "Call signature", @@ -22708,24 +23253,24 @@ }, "parameters": [ { - "id": 377, + "id": 373, "name": "identity", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity", "dereferenced": { - "id": 648, + "id": 669, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 657, + "id": 678, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -22745,7 +23290,7 @@ } }, { - "id": 649, + "id": 670, "name": "id", "kind": 1024, "kindString": "Property", @@ -22763,7 +23308,7 @@ } }, { - "id": 651, + "id": 672, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -22780,20 +23325,20 @@ "type": { "type": "reflection", "declaration": { - "id": 652, + "id": 673, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 653, + "id": 674, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 654, + "id": 675, "name": "key", "kind": 32768, "flags": {}, @@ -22812,7 +23357,7 @@ } }, { - "id": 655, + "id": 676, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -22830,7 +23375,7 @@ } }, { - "id": 658, + "id": 679, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -22850,7 +23395,7 @@ } }, { - "id": 656, + "id": 677, "name": "provider", "kind": 1024, "kindString": "Property", @@ -22868,7 +23413,7 @@ } }, { - "id": 659, + "id": 680, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -22888,7 +23433,7 @@ } }, { - "id": 650, + "id": 671, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -22910,7 +23455,7 @@ { "title": "Properties", "kind": 1024, - "children": [657, 649, 651, 655, 658, 656, 659, 650] + "children": [678, 670, 672, 676, 679, 677, 680, 671] } ], "sources": [ @@ -22930,6 +23475,67 @@ { "type": "union", "types": [ + { + "type": "reflection", + "declaration": { + "id": 374, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1795, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 376, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 377, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1796, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [375, 377] + } + ] + } + }, { "type": "reflection", "declaration": { @@ -22945,30 +23551,6 @@ "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1797, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 380, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 381, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -22980,46 +23562,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [379, 381] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 383, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1800, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 384, + "id": 380, "name": "error", "kind": 1024, "kindString": "Property", @@ -23027,13 +23572,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1800, + "line": 1798, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -23042,7 +23587,7 @@ { "title": "Properties", "kind": 1024, - "children": [383, 384] + "children": [379, 380] } ] } @@ -23058,7 +23603,7 @@ ] }, { - "id": 252, + "id": 255, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -23066,13 +23611,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1227, + "line": 1236, "character": 8 } ], "signatures": [ { - "id": 253, + "id": 256, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -23082,24 +23627,24 @@ }, "parameters": [ { - "id": 254, + "id": 257, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes", "dereferenced": { - "id": 699, + "id": 720, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 704, + "id": 725, "name": "data", "kind": 1024, "kindString": "Property", @@ -23123,7 +23668,7 @@ } }, { - "id": 700, + "id": 721, "name": "email", "kind": 1024, "kindString": "Property", @@ -23146,7 +23691,7 @@ } }, { - "id": 703, + "id": 724, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -23170,7 +23715,7 @@ } }, { - "id": 702, + "id": 723, "name": "password", "kind": 1024, "kindString": "Property", @@ -23193,7 +23738,7 @@ } }, { - "id": 701, + "id": 722, "name": "phone", "kind": 1024, "kindString": "Property", @@ -23220,7 +23765,7 @@ { "title": "Properties", "kind": 1024, - "children": [704, 700, 703, 702, 701] + "children": [725, 721, 724, 723, 722] } ], "sources": [ @@ -23234,7 +23779,7 @@ } }, { - "id": 255, + "id": 258, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -23242,14 +23787,14 @@ "type": { "type": "reflection", "declaration": { - "id": 256, + "id": 259, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 260, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -23259,7 +23804,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1230, + "line": 1239, "character": 6 } ], @@ -23273,7 +23818,7 @@ { "title": "Properties", "kind": 1024, - "children": [257] + "children": [260] } ] } @@ -23286,7 +23831,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -23298,7 +23843,7 @@ ] }, { - "id": 170, + "id": 173, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -23306,13 +23851,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 752, + "line": 761, "character": 8 } ], "signatures": [ { - "id": 171, + "id": 174, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -23322,17 +23867,17 @@ }, "parameters": [ { - "id": 172, + "id": 175, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 802, + "id": 823, "name": "VerifyOtpParams", "dereferenced": { - "id": 802, + "id": 823, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -23348,14 +23893,14 @@ "type": "union", "types": [ { - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -23372,14 +23917,14 @@ "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23408,7 +23953,7 @@ } }, { - "id": 809, + "id": 830, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -23435,14 +23980,14 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ] } } }, { - "id": 804, + "id": 825, "name": "phone", "kind": 1024, "kindString": "Property", @@ -23463,7 +24008,7 @@ } }, { - "id": 805, + "id": 826, "name": "token", "kind": 1024, "kindString": "Property", @@ -23484,7 +24029,7 @@ } }, { - "id": 806, + "id": 827, "name": "type", "kind": 1024, "kindString": "Property", @@ -23501,10 +24046,10 @@ ], "type": { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType", "dereferenced": { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -23537,7 +24082,7 @@ { "title": "Properties", "kind": 1024, - "children": [807, 804, 805, 806] + "children": [828, 825, 826, 827] } ], "sources": [ @@ -23549,14 +24094,14 @@ ] }, { - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 812, + "id": 833, "name": "email", "kind": 1024, "kindString": "Property", @@ -23577,7 +24122,7 @@ } }, { - "id": 815, + "id": 836, "name": "options", "kind": 1024, "kindString": "Property", @@ -23594,14 +24139,14 @@ "type": { "type": "reflection", "declaration": { - "id": 816, + "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 818, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23630,7 +24175,7 @@ } }, { - "id": 817, + "id": 838, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -23657,14 +24202,14 @@ { "title": "Properties", "kind": 1024, - "children": [818, 817] + "children": [839, 838] } ] } } }, { - "id": 813, + "id": 834, "name": "token", "kind": 1024, "kindString": "Property", @@ -23685,7 +24230,7 @@ } }, { - "id": 814, + "id": 835, "name": "type", "kind": 1024, "kindString": "Property", @@ -23702,10 +24247,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -23754,7 +24299,7 @@ { "title": "Properties", "kind": 1024, - "children": [812, 815, 813, 814] + "children": [833, 836, 834, 835] } ], "sources": [ @@ -23766,14 +24311,14 @@ ] }, { - "id": 819, + "id": 840, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -23794,7 +24339,7 @@ } }, { - "id": 821, + "id": 842, "name": "type", "kind": 1024, "kindString": "Property", @@ -23811,10 +24356,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -23863,7 +24408,7 @@ { "title": "Properties", "kind": 1024, - "children": [820, 821] + "children": [841, 842] } ], "sources": [ @@ -23885,7 +24430,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -23912,42 +24457,42 @@ "title": "Methods", "kind": 2048, "children": [ - 144, 183, 246, 362, 128, 372, 334, 176, 283, 180, 348, 271, 132, 164, 141, 167, 138, - 173, 324, 135, 430, 432, 375, 252, 170 + 147, 477, 186, 249, 358, 131, 368, 330, 179, 279, 183, 344, 267, 135, 167, 144, 170, + 141, 176, 320, 138, 426, 428, 371, 255, 173 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 123, + "line": 129, "character": 21 } ] }, { - "id": 485, + "id": 506, "name": "NavigatorLockAcquireTimeoutError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 486, + "id": 507, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 487, + "id": 508, "name": "new NavigatorLockAcquireTimeoutError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 488, + "id": 509, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -23960,7 +24505,7 @@ ], "type": { "type": "reference", - "id": 485, + "id": 506, "name": "NavigatorLockAcquireTimeoutError" }, "inheritedFrom": { @@ -23975,7 +24520,7 @@ } }, { - "id": 489, + "id": 510, "name": "isAcquireTimeout", "kind": 1024, "kindString": "Property", @@ -24005,12 +24550,12 @@ { "title": "Constructors", "kind": 512, - "children": [486] + "children": [507] }, { "title": "Properties", "kind": 1024, - "children": [489] + "children": [510] } ], "sources": [ @@ -24028,7 +24573,7 @@ ] }, { - "id": 644, + "id": 665, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -24045,7 +24590,7 @@ }, "children": [ { - "id": 645, + "id": 666, "name": "method", "kind": 1024, "kindString": "Property", @@ -24077,7 +24622,7 @@ { "type": "reflection", "declaration": { - "id": 646, + "id": 667, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -24102,7 +24647,7 @@ } }, { - "id": 647, + "id": 668, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -24127,7 +24672,7 @@ { "title": "Properties", "kind": 1024, - "children": [645, 647] + "children": [666, 668] } ], "sources": [ @@ -24139,14 +24684,14 @@ ] }, { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -24170,7 +24715,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -24194,7 +24739,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -24221,7 +24766,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -24245,7 +24790,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -24269,7 +24814,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -24297,7 +24842,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -24324,7 +24869,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -24348,7 +24893,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -24375,7 +24920,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -24399,7 +24944,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -24423,7 +24968,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -24451,7 +24996,7 @@ { "title": "Properties", "kind": 1024, - "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] + "children": [728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727] } ], "sources": [ @@ -24467,7 +25012,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -24482,7 +25027,7 @@ ] }, { - "id": 660, + "id": 681, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -24506,7 +25051,7 @@ }, "children": [ { - "id": 666, + "id": 687, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -24524,7 +25069,7 @@ } }, { - "id": 663, + "id": 684, "name": "factor_type", "kind": 1024, "kindString": "Property", @@ -24552,7 +25097,7 @@ { "type": "reflection", "declaration": { - "id": 664, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -24573,7 +25118,7 @@ } }, { - "id": 662, + "id": 683, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -24596,7 +25141,7 @@ } }, { - "id": 661, + "id": 682, "name": "id", "kind": 1024, "kindString": "Property", @@ -24617,7 +25162,7 @@ } }, { - "id": 665, + "id": 686, "name": "status", "kind": 1024, "kindString": "Property", @@ -24647,7 +25192,7 @@ } }, { - "id": 667, + "id": 688, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -24669,7 +25214,7 @@ { "title": "Properties", "kind": 1024, - "children": [666, 663, 662, 661, 665, 667] + "children": [687, 684, 683, 682, 686, 688] } ], "sources": [ @@ -24681,14 +25226,14 @@ ] }, { - "id": 873, + "id": 894, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 874, + "id": 895, "name": "data", "kind": 1024, "kindString": "Property", @@ -24712,7 +25257,7 @@ } }, { - "id": 875, + "id": 896, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -24739,7 +25284,7 @@ { "title": "Properties", "kind": 1024, - "children": [874, 875] + "children": [895, 896] } ], "sources": [ @@ -24751,7 +25296,7 @@ ] }, { - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -24767,14 +25312,14 @@ }, "children": [ { - "id": 1025, + "id": 1046, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1026, + "id": 1047, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -24794,17 +25339,17 @@ }, "parameters": [ { - "id": 1027, + "id": 1048, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -24827,14 +25372,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -24855,7 +25400,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -24880,7 +25425,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -24901,7 +25446,7 @@ "typeArguments": [ { "type": "reference", - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -24913,14 +25458,14 @@ ] }, { - "id": 1022, + "id": 1043, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1023, + "id": 1044, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -24930,17 +25475,17 @@ }, "parameters": [ { - "id": 1024, + "id": 1045, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -24963,14 +25508,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -24995,7 +25540,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -25016,7 +25561,7 @@ "typeArguments": [ { "type": "reference", - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -25032,7 +25577,7 @@ { "title": "Methods", "kind": 2048, - "children": [1025, 1022] + "children": [1046, 1043] } ], "sources": [ @@ -25044,7 +25589,7 @@ ] }, { - "id": 972, + "id": 993, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -25054,14 +25599,14 @@ }, "children": [ { - "id": 980, + "id": 1001, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 1002, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -25071,17 +25616,17 @@ }, "parameters": [ { - "id": 982, + "id": 1003, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 907, + "id": 928, "name": "MFAChallengeParams", "dereferenced": { - "id": 907, + "id": 928, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -25096,14 +25641,14 @@ "type": { "type": "reflection", "declaration": { - "id": 908, + "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 910, + "id": 931, "name": "channel", "kind": 1024, "kindString": "Property", @@ -25135,7 +25680,7 @@ } }, { - "id": 909, + "id": 930, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -25160,7 +25705,7 @@ { "title": "Properties", "kind": 1024, - "children": [910, 909] + "children": [931, 930] } ], "sources": [ @@ -25181,7 +25726,7 @@ "typeArguments": [ { "type": "reference", - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse" } ], @@ -25193,14 +25738,14 @@ ] }, { - "id": 989, + "id": 1010, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 990, + "id": 1011, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -25210,17 +25755,17 @@ }, "parameters": [ { - "id": 991, + "id": 1012, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -25235,14 +25780,14 @@ "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 933, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 914, + "id": 935, "name": "code", "kind": 1024, "kindString": "Property", @@ -25263,7 +25808,7 @@ } }, { - "id": 913, + "id": 934, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -25288,7 +25833,7 @@ { "title": "Properties", "kind": 1024, - "children": [914, 913] + "children": [935, 934] } ], "sources": [ @@ -25309,7 +25854,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -25321,14 +25866,14 @@ ] }, { - "id": 973, + "id": 994, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 974, + "id": 995, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -25339,17 +25884,17 @@ }, "parameters": [ { - "id": 975, + "id": 996, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -25364,14 +25909,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -25392,7 +25937,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -25415,7 +25960,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -25442,7 +25987,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -25463,7 +26008,7 @@ "typeArguments": [ { "type": "reference", - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse" } ], @@ -25473,24 +26018,24 @@ } }, { - "id": 976, + "id": 997, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 977, + "id": 998, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -25505,14 +26050,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -25533,7 +26078,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -25556,7 +26101,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -25581,7 +26126,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -25602,7 +26147,7 @@ "typeArguments": [ { "type": "reference", - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse" } ], @@ -25612,24 +26157,24 @@ } }, { - "id": 978, + "id": 999, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 979, + "id": 1000, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 898, + "id": 919, "name": "MFAEnrollParams", "dereferenced": { - "id": 898, + "id": 919, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -25645,7 +26190,7 @@ "type": "union", "types": [ { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -25660,14 +26205,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -25688,7 +26233,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -25711,7 +26256,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -25738,7 +26283,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -25752,7 +26297,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -25767,14 +26312,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -25795,7 +26340,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -25818,7 +26363,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -25843,7 +26388,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -25867,7 +26412,7 @@ "typeArguments": [ { "type": "reference", - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse" } ], @@ -25879,14 +26424,14 @@ ] }, { - "id": 994, + "id": 1015, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 995, + "id": 1016, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -25900,7 +26445,7 @@ "typeArguments": [ { "type": "reference", - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -25912,14 +26457,14 @@ ] }, { - "id": 992, + "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 993, + "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -25946,7 +26491,7 @@ "typeArguments": [ { "type": "reference", - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse" } ], @@ -25958,14 +26503,14 @@ ] }, { - "id": 986, + "id": 1007, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 987, + "id": 1008, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -25975,17 +26520,17 @@ }, "parameters": [ { - "id": 988, + "id": 1009, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "dereferenced": { - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -26000,14 +26545,14 @@ "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 922, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -26032,7 +26577,7 @@ { "title": "Properties", "kind": 1024, - "children": [901] + "children": [922] } ], "sources": [ @@ -26053,7 +26598,7 @@ "typeArguments": [ { "type": "reference", - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse" } ], @@ -26065,14 +26610,14 @@ ] }, { - "id": 983, + "id": 1004, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 1005, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -26082,17 +26627,17 @@ }, "parameters": [ { - "id": 985, + "id": 1006, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 902, + "id": 923, "name": "MFAVerifyParams", "dereferenced": { - "id": 902, + "id": 923, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -26107,14 +26652,14 @@ "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 924, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 926, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -26135,7 +26680,7 @@ } }, { - "id": 906, + "id": 927, "name": "code", "kind": 1024, "kindString": "Property", @@ -26156,7 +26701,7 @@ } }, { - "id": 904, + "id": 925, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -26181,7 +26726,7 @@ { "title": "Properties", "kind": 1024, - "children": [905, 906, 904] + "children": [926, 927, 925] } ], "sources": [ @@ -26202,7 +26747,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -26218,7 +26763,7 @@ { "title": "Methods", "kind": 2048, - "children": [980, 989, 973, 994, 992, 986, 983] + "children": [1001, 1010, 994, 1015, 1013, 1007, 1004] } ], "sources": [ @@ -26230,14 +26775,152 @@ ] }, { - "id": 635, + "id": 1133, + "name": "JWK", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 1136, + "name": "alg", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1227, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1135, + "name": "key_ops", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1226, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1137, + "name": "kid", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1228, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1134, + "name": "kty", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1225, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "RSA" + }, + { + "type": "literal", + "value": "EC" + }, + { + "type": "literal", + "value": "oct" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1136, 1135, 1137, 1134] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1224, + "character": 17 + } + ], + "indexSignature": { + "id": 1138, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 1139, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 656, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 638, + "id": 659, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -26258,7 +26941,7 @@ } }, { - "id": 641, + "id": 662, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -26281,7 +26964,7 @@ } }, { - "id": 640, + "id": 661, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -26302,7 +26985,7 @@ } }, { - "id": 637, + "id": 658, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -26334,7 +27017,7 @@ } }, { - "id": 636, + "id": 657, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -26366,7 +27049,7 @@ } }, { - "id": 639, + "id": 660, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -26387,7 +27070,7 @@ } }, { - "id": 642, + "id": 663, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -26405,7 +27088,7 @@ } }, { - "id": 643, + "id": 664, "name": "user", "kind": 1024, "kindString": "Property", @@ -26419,17 +27102,17 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User", "dereferenced": { - "id": 675, + "id": 696, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 686, + "id": 707, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -26449,7 +27132,7 @@ } }, { - "id": 677, + "id": 698, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -26463,17 +27146,17 @@ ], "type": { "type": "reference", - "id": 668, + "id": 689, "name": "UserAppMetadata", "dereferenced": { - "id": 668, + "id": 689, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 669, + "id": 690, "name": "provider", "kind": 1024, "kindString": "Property", @@ -26497,7 +27180,7 @@ { "title": "Properties", "kind": 1024, - "children": [669] + "children": [690] } ], "sources": [ @@ -26508,14 +27191,14 @@ } ], "indexSignature": { - "id": 670, + "id": 691, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 692, "name": "key", "kind": 32768, "flags": {}, @@ -26534,7 +27217,7 @@ } }, { - "id": 679, + "id": 700, "name": "aud", "kind": 1024, "kindString": "Property", @@ -26552,7 +27235,7 @@ } }, { - "id": 680, + "id": 701, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -26572,7 +27255,7 @@ } }, { - "id": 690, + "id": 711, "name": "confirmed_at", "kind": 1024, "kindString": "Property", @@ -26592,7 +27275,7 @@ } }, { - "id": 689, + "id": 710, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -26610,7 +27293,7 @@ } }, { - "id": 687, + "id": 708, "name": "email", "kind": 1024, "kindString": "Property", @@ -26630,7 +27313,7 @@ } }, { - "id": 682, + "id": 703, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", @@ -26650,7 +27333,7 @@ } }, { - "id": 691, + "id": 712, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", @@ -26670,7 +27353,7 @@ } }, { - "id": 698, + "id": 719, "name": "factors", "kind": 1024, "kindString": "Property", @@ -26688,13 +27371,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 676, + "id": 697, "name": "id", "kind": 1024, "kindString": "Property", @@ -26712,7 +27395,7 @@ } }, { - "id": 696, + "id": 717, "name": "identities", "kind": 1024, "kindString": "Property", @@ -26730,13 +27413,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } }, { - "id": 685, + "id": 706, "name": "invited_at", "kind": 1024, "kindString": "Property", @@ -26756,7 +27439,7 @@ } }, { - "id": 697, + "id": 718, "name": "is_anonymous", "kind": 1024, "kindString": "Property", @@ -26776,7 +27459,7 @@ } }, { - "id": 693, + "id": 714, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -26796,7 +27479,7 @@ } }, { - "id": 683, + "id": 704, "name": "new_email", "kind": 1024, "kindString": "Property", @@ -26816,7 +27499,7 @@ } }, { - "id": 684, + "id": 705, "name": "new_phone", "kind": 1024, "kindString": "Property", @@ -26836,7 +27519,7 @@ } }, { - "id": 688, + "id": 709, "name": "phone", "kind": 1024, "kindString": "Property", @@ -26856,7 +27539,7 @@ } }, { - "id": 692, + "id": 713, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", @@ -26876,7 +27559,7 @@ } }, { - "id": 681, + "id": 702, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -26896,7 +27579,7 @@ } }, { - "id": 694, + "id": 715, "name": "role", "kind": 1024, "kindString": "Property", @@ -26916,7 +27599,7 @@ } }, { - "id": 695, + "id": 716, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -26936,7 +27619,7 @@ } }, { - "id": 678, + "id": 699, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -26950,10 +27633,10 @@ ], "type": { "type": "reference", - "id": 672, + "id": 693, "name": "UserMetadata", "dereferenced": { - "id": 672, + "id": 693, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -26966,14 +27649,14 @@ } ], "indexSignature": { - "id": 673, + "id": 694, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 674, + "id": 695, "name": "key", "kind": 32768, "flags": {}, @@ -26997,8 +27680,8 @@ "title": "Properties", "kind": 1024, "children": [ - 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, - 683, 684, 688, 692, 681, 694, 695, 678 + 707, 698, 700, 701, 711, 710, 708, 703, 712, 719, 697, 717, 706, 718, 714, + 704, 705, 709, 713, 702, 715, 716, 699 ] } ], @@ -27017,7 +27700,7 @@ { "title": "Properties", "kind": 1024, - "children": [638, 641, 640, 637, 636, 639, 642, 643] + "children": [659, 662, 661, 658, 657, 660, 663, 664] } ], "sources": [ @@ -27029,14 +27712,14 @@ ] }, { - "id": 718, + "id": 739, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 719, + "id": 740, "name": "id", "kind": 1024, "kindString": "Property", @@ -27057,7 +27740,7 @@ } }, { - "id": 720, + "id": 741, "name": "callback", "kind": 2048, "kindString": "Method", @@ -27071,7 +27754,7 @@ ], "signatures": [ { - "id": 721, + "id": 742, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -27081,17 +27764,17 @@ }, "parameters": [ { - "id": 722, + "id": 743, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent", "dereferenced": { - "id": 495, + "id": 516, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -27131,7 +27814,7 @@ "value": "USER_UPDATED" }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -27154,7 +27837,7 @@ } }, { - "id": 723, + "id": 744, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -27168,7 +27851,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -27183,7 +27866,7 @@ ] }, { - "id": 724, + "id": 745, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -27197,7 +27880,7 @@ ], "signatures": [ { - "id": 725, + "id": 746, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -27217,12 +27900,12 @@ { "title": "Properties", "kind": 1024, - "children": [719] + "children": [740] }, { "title": "Methods", "kind": 2048, - "children": [720, 724] + "children": [741, 745] } ], "sources": [ @@ -27234,14 +27917,14 @@ ] }, { - "id": 675, + "id": 696, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 686, + "id": 707, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -27261,7 +27944,7 @@ } }, { - "id": 677, + "id": 698, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -27275,17 +27958,17 @@ ], "type": { "type": "reference", - "id": 668, + "id": 689, "name": "UserAppMetadata", "dereferenced": { - "id": 668, + "id": 689, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 669, + "id": 690, "name": "provider", "kind": 1024, "kindString": "Property", @@ -27309,7 +27992,7 @@ { "title": "Properties", "kind": 1024, - "children": [669] + "children": [690] } ], "sources": [ @@ -27320,14 +28003,14 @@ } ], "indexSignature": { - "id": 670, + "id": 691, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 692, "name": "key", "kind": 32768, "flags": {}, @@ -27346,7 +28029,7 @@ } }, { - "id": 679, + "id": 700, "name": "aud", "kind": 1024, "kindString": "Property", @@ -27364,7 +28047,7 @@ } }, { - "id": 680, + "id": 701, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -27384,7 +28067,7 @@ } }, { - "id": 690, + "id": 711, "name": "confirmed_at", "kind": 1024, "kindString": "Property", @@ -27404,7 +28087,7 @@ } }, { - "id": 689, + "id": 710, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -27422,7 +28105,7 @@ } }, { - "id": 687, + "id": 708, "name": "email", "kind": 1024, "kindString": "Property", @@ -27442,7 +28125,7 @@ } }, { - "id": 682, + "id": 703, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", @@ -27462,7 +28145,7 @@ } }, { - "id": 691, + "id": 712, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", @@ -27482,7 +28165,7 @@ } }, { - "id": 698, + "id": 719, "name": "factors", "kind": 1024, "kindString": "Property", @@ -27500,13 +28183,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 676, + "id": 697, "name": "id", "kind": 1024, "kindString": "Property", @@ -27524,7 +28207,7 @@ } }, { - "id": 696, + "id": 717, "name": "identities", "kind": 1024, "kindString": "Property", @@ -27542,13 +28225,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } }, { - "id": 685, + "id": 706, "name": "invited_at", "kind": 1024, "kindString": "Property", @@ -27568,7 +28251,7 @@ } }, { - "id": 697, + "id": 718, "name": "is_anonymous", "kind": 1024, "kindString": "Property", @@ -27588,7 +28271,7 @@ } }, { - "id": 693, + "id": 714, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -27608,7 +28291,7 @@ } }, { - "id": 683, + "id": 704, "name": "new_email", "kind": 1024, "kindString": "Property", @@ -27628,7 +28311,7 @@ } }, { - "id": 684, + "id": 705, "name": "new_phone", "kind": 1024, "kindString": "Property", @@ -27648,7 +28331,7 @@ } }, { - "id": 688, + "id": 709, "name": "phone", "kind": 1024, "kindString": "Property", @@ -27668,7 +28351,7 @@ } }, { - "id": 692, + "id": 713, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", @@ -27688,7 +28371,7 @@ } }, { - "id": 681, + "id": 702, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -27708,7 +28391,7 @@ } }, { - "id": 694, + "id": 715, "name": "role", "kind": 1024, "kindString": "Property", @@ -27728,7 +28411,7 @@ } }, { - "id": 695, + "id": 716, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -27748,7 +28431,7 @@ } }, { - "id": 678, + "id": 699, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -27762,10 +28445,10 @@ ], "type": { "type": "reference", - "id": 672, + "id": 693, "name": "UserMetadata", "dereferenced": { - "id": 672, + "id": 693, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -27778,14 +28461,14 @@ } ], "indexSignature": { - "id": 673, + "id": 694, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 674, + "id": 695, "name": "key", "kind": 32768, "flags": {}, @@ -27809,8 +28492,8 @@ "title": "Properties", "kind": 1024, "children": [ - 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, 684, - 688, 692, 681, 694, 695, 678 + 707, 698, 700, 701, 711, 710, 708, 703, 712, 719, 697, 717, 706, 718, 714, 704, 705, + 709, 713, 702, 715, 716, 699 ] } ], @@ -27823,14 +28506,14 @@ ] }, { - "id": 668, + "id": 689, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 669, + "id": 690, "name": "provider", "kind": 1024, "kindString": "Property", @@ -27854,7 +28537,7 @@ { "title": "Properties", "kind": 1024, - "children": [669] + "children": [690] } ], "sources": [ @@ -27865,14 +28548,14 @@ } ], "indexSignature": { - "id": 670, + "id": 691, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 692, "name": "key", "kind": 32768, "flags": {}, @@ -27889,14 +28572,14 @@ } }, { - "id": 699, + "id": 720, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 704, + "id": 725, "name": "data", "kind": 1024, "kindString": "Property", @@ -27920,7 +28603,7 @@ } }, { - "id": 700, + "id": 721, "name": "email", "kind": 1024, "kindString": "Property", @@ -27943,7 +28626,7 @@ } }, { - "id": 703, + "id": 724, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -27967,7 +28650,7 @@ } }, { - "id": 702, + "id": 723, "name": "password", "kind": 1024, "kindString": "Property", @@ -27990,7 +28673,7 @@ } }, { - "id": 701, + "id": 722, "name": "phone", "kind": 1024, "kindString": "Property", @@ -28017,7 +28700,7 @@ { "title": "Properties", "kind": 1024, - "children": [704, 700, 703, 702, 701] + "children": [725, 721, 724, 723, 722] } ], "sources": [ @@ -28029,14 +28712,14 @@ ] }, { - "id": 648, + "id": 669, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 657, + "id": 678, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -28056,7 +28739,7 @@ } }, { - "id": 649, + "id": 670, "name": "id", "kind": 1024, "kindString": "Property", @@ -28074,7 +28757,7 @@ } }, { - "id": 651, + "id": 672, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -28091,20 +28774,20 @@ "type": { "type": "reflection", "declaration": { - "id": 652, + "id": 673, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 653, + "id": 674, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 654, + "id": 675, "name": "key", "kind": 32768, "flags": {}, @@ -28123,7 +28806,7 @@ } }, { - "id": 655, + "id": 676, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -28141,7 +28824,7 @@ } }, { - "id": 658, + "id": 679, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -28161,7 +28844,7 @@ } }, { - "id": 656, + "id": 677, "name": "provider", "kind": 1024, "kindString": "Property", @@ -28179,7 +28862,7 @@ } }, { - "id": 659, + "id": 680, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -28199,7 +28882,7 @@ } }, { - "id": 650, + "id": 671, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -28221,7 +28904,7 @@ { "title": "Properties", "kind": 1024, - "children": [657, 649, 651, 655, 658, 656, 659, 650] + "children": [678, 670, 672, 676, 679, 677, 680, 671] } ], "sources": [ @@ -28233,7 +28916,7 @@ ] }, { - "id": 672, + "id": 693, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -28246,14 +28929,14 @@ } ], "indexSignature": { - "id": 673, + "id": 694, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 674, + "id": 695, "name": "key", "kind": 32768, "flags": {}, @@ -28270,14 +28953,14 @@ } }, { - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 812, + "id": 833, "name": "email", "kind": 1024, "kindString": "Property", @@ -28298,7 +28981,7 @@ } }, { - "id": 815, + "id": 836, "name": "options", "kind": 1024, "kindString": "Property", @@ -28315,14 +28998,14 @@ "type": { "type": "reflection", "declaration": { - "id": 816, + "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 818, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28351,7 +29034,7 @@ } }, { - "id": 817, + "id": 838, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -28378,14 +29061,14 @@ { "title": "Properties", "kind": 1024, - "children": [818, 817] + "children": [839, 838] } ] } } }, { - "id": 813, + "id": 834, "name": "token", "kind": 1024, "kindString": "Property", @@ -28406,7 +29089,7 @@ } }, { - "id": 814, + "id": 835, "name": "type", "kind": 1024, "kindString": "Property", @@ -28423,10 +29106,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -28475,7 +29158,7 @@ { "title": "Properties", "kind": 1024, - "children": [812, 815, 813, 814] + "children": [833, 836, 834, 835] } ], "sources": [ @@ -28487,14 +29170,14 @@ ] }, { - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -28511,14 +29194,14 @@ "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28547,7 +29230,7 @@ } }, { - "id": 809, + "id": 830, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -28574,14 +29257,14 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ] } } }, { - "id": 804, + "id": 825, "name": "phone", "kind": 1024, "kindString": "Property", @@ -28602,7 +29285,7 @@ } }, { - "id": 805, + "id": 826, "name": "token", "kind": 1024, "kindString": "Property", @@ -28623,7 +29306,7 @@ } }, { - "id": 806, + "id": 827, "name": "type", "kind": 1024, "kindString": "Property", @@ -28640,10 +29323,10 @@ ], "type": { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType", "dereferenced": { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -28676,7 +29359,7 @@ { "title": "Properties", "kind": 1024, - "children": [807, 804, 805, 806] + "children": [828, 825, 826, 827] } ], "sources": [ @@ -28688,14 +29371,14 @@ ] }, { - "id": 819, + "id": 840, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -28716,7 +29399,7 @@ } }, { - "id": 821, + "id": 842, "name": "type", "kind": 1024, "kindString": "Property", @@ -28733,10 +29416,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -28785,7 +29468,7 @@ { "title": "Properties", "kind": 1024, - "children": [820, 821] + "children": [841, 842] } ], "sources": [ @@ -28797,7 +29480,7 @@ ] }, { - "id": 495, + "id": 516, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -28837,7 +29520,7 @@ "value": "USER_UPDATED" }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -28858,7 +29541,7 @@ } }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -28876,7 +29559,7 @@ } }, { - "id": 779, + "id": 800, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -28903,7 +29586,7 @@ } }, { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -28926,14 +29609,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -28954,7 +29637,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -28979,7 +29662,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -28993,7 +29676,7 @@ } }, { - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", @@ -29019,14 +29702,14 @@ { "type": "reflection", "declaration": { - "id": 997, + "id": 1018, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1019, "name": "data", "kind": 1024, "kindString": "Property", @@ -29041,14 +29724,14 @@ "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1000, + "id": 1021, "name": "id", "kind": 1024, "kindString": "Property", @@ -29073,7 +29756,7 @@ { "title": "Properties", "kind": 1024, - "children": [1000] + "children": [1021] } ], "sources": [ @@ -29087,7 +29770,7 @@ } }, { - "id": 1001, + "id": 1022, "name": "error", "kind": 1024, "kindString": "Property", @@ -29109,7 +29792,7 @@ { "title": "Properties", "kind": 1024, - "children": [998, 1001] + "children": [1019, 1022] } ], "sources": [ @@ -29124,14 +29807,14 @@ { "type": "reflection", "declaration": { - "id": 1002, + "id": 1023, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1003, + "id": 1024, "name": "data", "kind": 1024, "kindString": "Property", @@ -29149,7 +29832,7 @@ } }, { - "id": 1004, + "id": 1025, "name": "error", "kind": 1024, "kindString": "Property", @@ -29163,7 +29846,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -29172,7 +29855,7 @@ { "title": "Properties", "kind": 1024, - "children": [1003, 1004] + "children": [1024, 1025] } ], "sources": [ @@ -29188,7 +29871,7 @@ } }, { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -29211,14 +29894,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -29243,7 +29926,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -29257,7 +29940,7 @@ } }, { - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -29283,14 +29966,14 @@ { "type": "reflection", "declaration": { - "id": 1010, + "id": 1031, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1032, "name": "data", "kind": 1024, "kindString": "Property", @@ -29305,14 +29988,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1012, + "id": 1033, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1013, + "id": 1034, "name": "factors", "kind": 1024, "kindString": "Property", @@ -29331,7 +30014,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } @@ -29341,7 +30024,7 @@ { "title": "Properties", "kind": 1024, - "children": [1013] + "children": [1034] } ], "sources": [ @@ -29355,7 +30038,7 @@ } }, { - "id": 1014, + "id": 1035, "name": "error", "kind": 1024, "kindString": "Property", @@ -29377,7 +30060,7 @@ { "title": "Properties", "kind": 1024, - "children": [1011, 1014] + "children": [1032, 1035] } ], "sources": [ @@ -29392,14 +30075,14 @@ { "type": "reflection", "declaration": { - "id": 1015, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1016, + "id": 1037, "name": "data", "kind": 1024, "kindString": "Property", @@ -29417,7 +30100,7 @@ } }, { - "id": 1017, + "id": 1038, "name": "error", "kind": 1024, "kindString": "Property", @@ -29431,7 +30114,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -29440,7 +30123,7 @@ { "title": "Properties", "kind": 1024, - "children": [1016, 1017] + "children": [1037, 1038] } ], "sources": [ @@ -29456,7 +30139,7 @@ } }, { - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -29474,14 +30157,14 @@ { "type": "reflection", "declaration": { - "id": 939, + "id": 960, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 940, + "id": 961, "name": "data", "kind": 1024, "kindString": "Property", @@ -29496,14 +30179,14 @@ "type": { "type": "reflection", "declaration": { - "id": 941, + "id": 962, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 944, + "id": 965, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -29524,7 +30207,7 @@ } }, { - "id": 942, + "id": 963, "name": "id", "kind": 1024, "kindString": "Property", @@ -29545,7 +30228,7 @@ } }, { - "id": 943, + "id": 964, "name": "type", "kind": 1024, "kindString": "Property", @@ -29579,7 +30262,7 @@ { "title": "Properties", "kind": 1024, - "children": [944, 942, 943] + "children": [965, 963, 964] } ], "sources": [ @@ -29593,7 +30276,7 @@ } }, { - "id": 945, + "id": 966, "name": "error", "kind": 1024, "kindString": "Property", @@ -29615,7 +30298,7 @@ { "title": "Properties", "kind": 1024, - "children": [940, 945] + "children": [961, 966] } ], "sources": [ @@ -29630,14 +30313,14 @@ { "type": "reflection", "declaration": { - "id": 946, + "id": 967, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 947, + "id": 968, "name": "data", "kind": 1024, "kindString": "Property", @@ -29655,7 +30338,7 @@ } }, { - "id": 948, + "id": 969, "name": "error", "kind": 1024, "kindString": "Property", @@ -29669,7 +30352,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -29678,7 +30361,7 @@ { "title": "Properties", "kind": 1024, - "children": [947, 948] + "children": [968, 969] } ], "sources": [ @@ -29694,7 +30377,7 @@ } }, { - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -29712,14 +30395,14 @@ { "type": "reflection", "declaration": { - "id": 1082, + "id": 1103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1083, + "id": 1104, "name": "data", "kind": 1024, "kindString": "Property", @@ -29734,14 +30417,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1084, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1087, + "id": 1108, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -29764,7 +30447,7 @@ } }, { - "id": 1085, + "id": 1106, "name": "id", "kind": 1024, "kindString": "Property", @@ -29785,7 +30468,7 @@ } }, { - "id": 1088, + "id": 1109, "name": "phone", "kind": 1024, "kindString": "Property", @@ -29806,7 +30489,7 @@ } }, { - "id": 1086, + "id": 1107, "name": "type", "kind": 1024, "kindString": "Property", @@ -29831,7 +30514,7 @@ { "title": "Properties", "kind": 1024, - "children": [1087, 1085, 1088, 1086] + "children": [1108, 1106, 1109, 1107] } ], "sources": [ @@ -29845,7 +30528,7 @@ } }, { - "id": 1089, + "id": 1110, "name": "error", "kind": 1024, "kindString": "Property", @@ -29867,7 +30550,7 @@ { "title": "Properties", "kind": 1024, - "children": [1083, 1089] + "children": [1104, 1110] } ], "sources": [ @@ -29882,14 +30565,14 @@ { "type": "reflection", "declaration": { - "id": 1090, + "id": 1111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1091, + "id": 1112, "name": "data", "kind": 1024, "kindString": "Property", @@ -29907,7 +30590,7 @@ } }, { - "id": 1092, + "id": 1113, "name": "error", "kind": 1024, "kindString": "Property", @@ -29921,7 +30604,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -29930,7 +30613,7 @@ { "title": "Properties", "kind": 1024, - "children": [1091, 1092] + "children": [1112, 1113] } ], "sources": [ @@ -29946,7 +30629,7 @@ } }, { - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -29962,7 +30645,7 @@ "type": "union", "types": [ { - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -29980,14 +30663,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1087, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1088, "name": "data", "kind": 1024, "kindString": "Property", @@ -30002,14 +30685,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1068, + "id": 1089, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1076, + "id": 1097, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -30032,7 +30715,7 @@ } }, { - "id": 1069, + "id": 1090, "name": "id", "kind": 1024, "kindString": "Property", @@ -30053,7 +30736,7 @@ } }, { - "id": 1071, + "id": 1092, "name": "totp", "kind": 1024, "kindString": "Property", @@ -30071,14 +30754,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1073, + "id": 1094, "name": "qr_code", "kind": 1024, "kindString": "Property", @@ -30099,7 +30782,7 @@ } }, { - "id": 1074, + "id": 1095, "name": "secret", "kind": 1024, "kindString": "Property", @@ -30120,7 +30803,7 @@ } }, { - "id": 1075, + "id": 1096, "name": "uri", "kind": 1024, "kindString": "Property", @@ -30145,7 +30828,7 @@ { "title": "Properties", "kind": 1024, - "children": [1073, 1074, 1075] + "children": [1094, 1095, 1096] } ], "sources": [ @@ -30159,7 +30842,7 @@ } }, { - "id": 1070, + "id": 1091, "name": "type", "kind": 1024, "kindString": "Property", @@ -30184,7 +30867,7 @@ { "title": "Properties", "kind": 1024, - "children": [1076, 1069, 1071, 1070] + "children": [1097, 1090, 1092, 1091] } ], "sources": [ @@ -30198,7 +30881,7 @@ } }, { - "id": 1077, + "id": 1098, "name": "error", "kind": 1024, "kindString": "Property", @@ -30220,7 +30903,7 @@ { "title": "Properties", "kind": 1024, - "children": [1067, 1077] + "children": [1088, 1098] } ], "sources": [ @@ -30235,14 +30918,14 @@ { "type": "reflection", "declaration": { - "id": 1078, + "id": 1099, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1079, + "id": 1100, "name": "data", "kind": 1024, "kindString": "Property", @@ -30260,7 +30943,7 @@ } }, { - "id": 1080, + "id": 1101, "name": "error", "kind": 1024, "kindString": "Property", @@ -30274,7 +30957,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -30283,7 +30966,7 @@ { "title": "Properties", "kind": 1024, - "children": [1079, 1080] + "children": [1100, 1101] } ], "sources": [ @@ -30299,7 +30982,7 @@ } }, { - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -30317,14 +31000,14 @@ { "type": "reflection", "declaration": { - "id": 1082, + "id": 1103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1083, + "id": 1104, "name": "data", "kind": 1024, "kindString": "Property", @@ -30339,14 +31022,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1084, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1087, + "id": 1108, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -30369,7 +31052,7 @@ } }, { - "id": 1085, + "id": 1106, "name": "id", "kind": 1024, "kindString": "Property", @@ -30390,7 +31073,7 @@ } }, { - "id": 1088, + "id": 1109, "name": "phone", "kind": 1024, "kindString": "Property", @@ -30411,7 +31094,7 @@ } }, { - "id": 1086, + "id": 1107, "name": "type", "kind": 1024, "kindString": "Property", @@ -30436,7 +31119,7 @@ { "title": "Properties", "kind": 1024, - "children": [1087, 1085, 1088, 1086] + "children": [1108, 1106, 1109, 1107] } ], "sources": [ @@ -30450,7 +31133,7 @@ } }, { - "id": 1089, + "id": 1110, "name": "error", "kind": 1024, "kindString": "Property", @@ -30472,7 +31155,7 @@ { "title": "Properties", "kind": 1024, - "children": [1083, 1089] + "children": [1104, 1110] } ], "sources": [ @@ -30487,14 +31170,14 @@ { "type": "reflection", "declaration": { - "id": 1090, + "id": 1111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1091, + "id": 1112, "name": "data", "kind": 1024, "kindString": "Property", @@ -30512,7 +31195,7 @@ } }, { - "id": 1092, + "id": 1113, "name": "error", "kind": 1024, "kindString": "Property", @@ -30526,7 +31209,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -30535,7 +31218,7 @@ { "title": "Properties", "kind": 1024, - "children": [1091, 1092] + "children": [1112, 1113] } ], "sources": [ @@ -30554,7 +31237,7 @@ } }, { - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -30572,14 +31255,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1087, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1088, "name": "data", "kind": 1024, "kindString": "Property", @@ -30594,14 +31277,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1068, + "id": 1089, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1076, + "id": 1097, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -30624,7 +31307,7 @@ } }, { - "id": 1069, + "id": 1090, "name": "id", "kind": 1024, "kindString": "Property", @@ -30645,7 +31328,7 @@ } }, { - "id": 1071, + "id": 1092, "name": "totp", "kind": 1024, "kindString": "Property", @@ -30663,14 +31346,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1073, + "id": 1094, "name": "qr_code", "kind": 1024, "kindString": "Property", @@ -30691,7 +31374,7 @@ } }, { - "id": 1074, + "id": 1095, "name": "secret", "kind": 1024, "kindString": "Property", @@ -30712,7 +31395,7 @@ } }, { - "id": 1075, + "id": 1096, "name": "uri", "kind": 1024, "kindString": "Property", @@ -30737,7 +31420,7 @@ { "title": "Properties", "kind": 1024, - "children": [1073, 1074, 1075] + "children": [1094, 1095, 1096] } ], "sources": [ @@ -30751,7 +31434,7 @@ } }, { - "id": 1070, + "id": 1091, "name": "type", "kind": 1024, "kindString": "Property", @@ -30776,7 +31459,7 @@ { "title": "Properties", "kind": 1024, - "children": [1076, 1069, 1071, 1070] + "children": [1097, 1090, 1092, 1091] } ], "sources": [ @@ -30790,7 +31473,7 @@ } }, { - "id": 1077, + "id": 1098, "name": "error", "kind": 1024, "kindString": "Property", @@ -30812,7 +31495,7 @@ { "title": "Properties", "kind": 1024, - "children": [1067, 1077] + "children": [1088, 1098] } ], "sources": [ @@ -30827,14 +31510,14 @@ { "type": "reflection", "declaration": { - "id": 1078, + "id": 1099, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1079, + "id": 1100, "name": "data", "kind": 1024, "kindString": "Property", @@ -30852,7 +31535,7 @@ } }, { - "id": 1080, + "id": 1101, "name": "error", "kind": 1024, "kindString": "Property", @@ -30866,7 +31549,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -30875,7 +31558,7 @@ { "title": "Properties", "kind": 1024, - "children": [1079, 1080] + "children": [1100, 1101] } ], "sources": [ @@ -30891,7 +31574,7 @@ } }, { - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -30909,14 +31592,14 @@ { "type": "reflection", "declaration": { - "id": 962, + "id": 983, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 963, + "id": 984, "name": "data", "kind": 1024, "kindString": "Property", @@ -30931,14 +31614,14 @@ "type": { "type": "reflection", "declaration": { - "id": 964, + "id": 985, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 967, + "id": 988, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", @@ -30957,13 +31640,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 644, + "id": 665, "name": "AMREntry" } } }, { - "id": 965, + "id": 986, "name": "currentLevel", "kind": 1024, "kindString": "Property", @@ -30983,7 +31666,7 @@ "types": [ { "type": "reference", - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels" }, { @@ -30994,7 +31677,7 @@ } }, { - "id": 966, + "id": 987, "name": "nextLevel", "kind": 1024, "kindString": "Property", @@ -31020,7 +31703,7 @@ "types": [ { "type": "reference", - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels" }, { @@ -31035,7 +31718,7 @@ { "title": "Properties", "kind": 1024, - "children": [967, 965, 966] + "children": [988, 986, 987] } ], "sources": [ @@ -31049,7 +31732,7 @@ } }, { - "id": 968, + "id": 989, "name": "error", "kind": 1024, "kindString": "Property", @@ -31071,7 +31754,7 @@ { "title": "Properties", "kind": 1024, - "children": [963, 968] + "children": [984, 989] } ], "sources": [ @@ -31086,14 +31769,14 @@ { "type": "reflection", "declaration": { - "id": 969, + "id": 990, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 970, + "id": 991, "name": "data", "kind": 1024, "kindString": "Property", @@ -31111,7 +31794,7 @@ } }, { - "id": 971, + "id": 992, "name": "error", "kind": 1024, "kindString": "Property", @@ -31125,7 +31808,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -31134,7 +31817,7 @@ { "title": "Properties", "kind": 1024, - "children": [970, 971] + "children": [991, 992] } ], "sources": [ @@ -31150,7 +31833,7 @@ } }, { - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -31168,14 +31851,14 @@ { "type": "reflection", "declaration": { - "id": 950, + "id": 971, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 951, + "id": 972, "name": "data", "kind": 1024, "kindString": "Property", @@ -31190,14 +31873,14 @@ "type": { "type": "reflection", "declaration": { - "id": 952, + "id": 973, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 953, + "id": 974, "name": "all", "kind": 1024, "kindString": "Property", @@ -31216,13 +31899,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 955, + "id": 976, "name": "phone", "kind": 1024, "kindString": "Property", @@ -31241,13 +31924,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 954, + "id": 975, "name": "totp", "kind": 1024, "kindString": "Property", @@ -31266,7 +31949,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } @@ -31276,7 +31959,7 @@ { "title": "Properties", "kind": 1024, - "children": [953, 955, 954] + "children": [974, 976, 975] } ], "sources": [ @@ -31290,7 +31973,7 @@ } }, { - "id": 956, + "id": 977, "name": "error", "kind": 1024, "kindString": "Property", @@ -31312,7 +31995,7 @@ { "title": "Properties", "kind": 1024, - "children": [951, 956] + "children": [972, 977] } ], "sources": [ @@ -31327,14 +32010,14 @@ { "type": "reflection", "declaration": { - "id": 957, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 979, "name": "data", "kind": 1024, "kindString": "Property", @@ -31352,7 +32035,7 @@ } }, { - "id": 959, + "id": 980, "name": "error", "kind": 1024, "kindString": "Property", @@ -31366,7 +32049,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -31375,7 +32058,7 @@ { "title": "Properties", "kind": 1024, - "children": [958, 959] + "children": [979, 980] } ], "sources": [ @@ -31391,7 +32074,7 @@ } }, { - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -31409,14 +32092,14 @@ { "type": "reflection", "declaration": { - "id": 930, + "id": 951, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 952, "name": "data", "kind": 1024, "kindString": "Property", @@ -31431,14 +32114,14 @@ "type": { "type": "reflection", "declaration": { - "id": 932, + "id": 953, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 933, + "id": 954, "name": "id", "kind": 1024, "kindString": "Property", @@ -31463,7 +32146,7 @@ { "title": "Properties", "kind": 1024, - "children": [933] + "children": [954] } ], "sources": [ @@ -31477,7 +32160,7 @@ } }, { - "id": 934, + "id": 955, "name": "error", "kind": 1024, "kindString": "Property", @@ -31499,7 +32182,7 @@ { "title": "Properties", "kind": 1024, - "children": [931, 934] + "children": [952, 955] } ], "sources": [ @@ -31514,14 +32197,14 @@ { "type": "reflection", "declaration": { - "id": 935, + "id": 956, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 936, + "id": 957, "name": "data", "kind": 1024, "kindString": "Property", @@ -31539,7 +32222,7 @@ } }, { - "id": 937, + "id": 958, "name": "error", "kind": 1024, "kindString": "Property", @@ -31553,7 +32236,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -31562,7 +32245,7 @@ { "title": "Properties", "kind": 1024, - "children": [936, 937] + "children": [957, 958] } ], "sources": [ @@ -31578,7 +32261,7 @@ } }, { - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -31596,14 +32279,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 937, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 938, "name": "data", "kind": 1024, "kindString": "Property", @@ -31618,14 +32301,14 @@ "type": { "type": "reflection", "declaration": { - "id": 918, + "id": 939, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 919, + "id": 940, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -31646,7 +32329,7 @@ } }, { - "id": 921, + "id": 942, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -31667,7 +32350,7 @@ } }, { - "id": 922, + "id": 943, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -31688,7 +32371,7 @@ } }, { - "id": 920, + "id": 941, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -31709,7 +32392,7 @@ } }, { - "id": 923, + "id": 944, "name": "user", "kind": 1024, "kindString": "Property", @@ -31726,7 +32409,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -31735,7 +32418,7 @@ { "title": "Properties", "kind": 1024, - "children": [919, 921, 922, 920, 923] + "children": [940, 942, 943, 941, 944] } ], "sources": [ @@ -31749,7 +32432,7 @@ } }, { - "id": 924, + "id": 945, "name": "error", "kind": 1024, "kindString": "Property", @@ -31771,7 +32454,7 @@ { "title": "Properties", "kind": 1024, - "children": [917, 924] + "children": [938, 945] } ], "sources": [ @@ -31786,14 +32469,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 946, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 947, "name": "data", "kind": 1024, "kindString": "Property", @@ -31811,7 +32494,7 @@ } }, { - "id": 927, + "id": 948, "name": "error", "kind": 1024, "kindString": "Property", @@ -31825,7 +32508,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -31834,7 +32517,7 @@ { "title": "Properties", "kind": 1024, - "children": [926, 927] + "children": [947, 948] } ], "sources": [ @@ -31850,7 +32533,7 @@ } }, { - "id": 559, + "id": 580, "name": "AuthOtpResponse", "kind": 4194304, "kindString": "Type alias", @@ -31872,14 +32555,14 @@ { "type": "reflection", "declaration": { - "id": 560, + "id": 581, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 561, + "id": 582, "name": "data", "kind": 1024, "kindString": "Property", @@ -31894,14 +32577,14 @@ "type": { "type": "reflection", "declaration": { - "id": 562, + "id": 583, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 565, + "id": 586, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -31930,7 +32613,7 @@ } }, { - "id": 564, + "id": 585, "name": "session", "kind": 1024, "kindString": "Property", @@ -31948,7 +32631,7 @@ } }, { - "id": 563, + "id": 584, "name": "user", "kind": 1024, "kindString": "Property", @@ -31970,7 +32653,7 @@ { "title": "Properties", "kind": 1024, - "children": [565, 564, 563] + "children": [586, 585, 584] } ], "sources": [ @@ -31984,7 +32667,7 @@ } }, { - "id": 566, + "id": 587, "name": "error", "kind": 1024, "kindString": "Property", @@ -32006,7 +32689,7 @@ { "title": "Properties", "kind": 1024, - "children": [561, 566] + "children": [582, 587] } ], "sources": [ @@ -32021,14 +32704,14 @@ { "type": "reflection", "declaration": { - "id": 567, + "id": 588, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 589, "name": "data", "kind": 1024, "kindString": "Property", @@ -32043,14 +32726,14 @@ "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 590, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 572, + "id": 593, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -32079,7 +32762,7 @@ } }, { - "id": 571, + "id": 592, "name": "session", "kind": 1024, "kindString": "Property", @@ -32097,7 +32780,7 @@ } }, { - "id": 570, + "id": 591, "name": "user", "kind": 1024, "kindString": "Property", @@ -32119,7 +32802,7 @@ { "title": "Properties", "kind": 1024, - "children": [572, 571, 570] + "children": [593, 592, 591] } ], "sources": [ @@ -32133,7 +32816,7 @@ } }, { - "id": 573, + "id": 594, "name": "error", "kind": 1024, "kindString": "Property", @@ -32147,7 +32830,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -32156,7 +32839,7 @@ { "title": "Properties", "kind": 1024, - "children": [568, 573] + "children": [589, 594] } ], "sources": [ @@ -32172,7 +32855,7 @@ } }, { - "id": 532, + "id": 553, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -32190,14 +32873,14 @@ { "type": "reflection", "declaration": { - "id": 533, + "id": 554, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 534, + "id": 555, "name": "data", "kind": 1024, "kindString": "Property", @@ -32212,14 +32895,14 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 537, + "id": 558, "name": "session", "kind": 1024, "kindString": "Property", @@ -32236,7 +32919,7 @@ "types": [ { "type": "reference", - "id": 635, + "id": 656, "name": "Session" }, { @@ -32247,7 +32930,7 @@ } }, { - "id": 536, + "id": 557, "name": "user", "kind": 1024, "kindString": "Property", @@ -32264,7 +32947,7 @@ "types": [ { "type": "reference", - "id": 675, + "id": 696, "name": "User" }, { @@ -32279,7 +32962,7 @@ { "title": "Properties", "kind": 1024, - "children": [537, 536] + "children": [558, 557] } ], "sources": [ @@ -32293,7 +32976,7 @@ } }, { - "id": 538, + "id": 559, "name": "error", "kind": 1024, "kindString": "Property", @@ -32315,7 +32998,7 @@ { "title": "Properties", "kind": 1024, - "children": [534, 538] + "children": [555, 559] } ], "sources": [ @@ -32330,14 +33013,14 @@ { "type": "reflection", "declaration": { - "id": 539, + "id": 560, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 540, + "id": 561, "name": "data", "kind": 1024, "kindString": "Property", @@ -32352,14 +33035,14 @@ "type": { "type": "reflection", "declaration": { - "id": 541, + "id": 562, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 543, + "id": 564, "name": "session", "kind": 1024, "kindString": "Property", @@ -32377,7 +33060,7 @@ } }, { - "id": 542, + "id": 563, "name": "user", "kind": 1024, "kindString": "Property", @@ -32399,7 +33082,7 @@ { "title": "Properties", "kind": 1024, - "children": [543, 542] + "children": [564, 563] } ], "sources": [ @@ -32413,7 +33096,7 @@ } }, { - "id": 544, + "id": 565, "name": "error", "kind": 1024, "kindString": "Property", @@ -32427,7 +33110,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -32436,7 +33119,7 @@ { "title": "Properties", "kind": 1024, - "children": [540, 544] + "children": [561, 565] } ], "sources": [ @@ -32452,7 +33135,7 @@ } }, { - "id": 545, + "id": 566, "name": "AuthResponsePassword", "kind": 4194304, "kindString": "Type alias", @@ -32470,14 +33153,14 @@ { "type": "reflection", "declaration": { - "id": 546, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 547, + "id": 568, "name": "data", "kind": 1024, "kindString": "Property", @@ -32492,14 +33175,14 @@ "type": { "type": "reflection", "declaration": { - "id": 548, + "id": 569, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 571, "name": "session", "kind": 1024, "kindString": "Property", @@ -32516,7 +33199,7 @@ "types": [ { "type": "reference", - "id": 635, + "id": 656, "name": "Session" }, { @@ -32527,7 +33210,7 @@ } }, { - "id": 549, + "id": 570, "name": "user", "kind": 1024, "kindString": "Property", @@ -32544,7 +33227,7 @@ "types": [ { "type": "reference", - "id": 675, + "id": 696, "name": "User" }, { @@ -32555,7 +33238,7 @@ } }, { - "id": 551, + "id": 572, "name": "weak_password", "kind": 1024, "kindString": "Property", @@ -32574,7 +33257,7 @@ "types": [ { "type": "reference", - "id": 528, + "id": 549, "name": "WeakPassword" }, { @@ -32589,7 +33272,7 @@ { "title": "Properties", "kind": 1024, - "children": [550, 549, 551] + "children": [571, 570, 572] } ], "sources": [ @@ -32603,7 +33286,7 @@ } }, { - "id": 552, + "id": 573, "name": "error", "kind": 1024, "kindString": "Property", @@ -32625,7 +33308,7 @@ { "title": "Properties", "kind": 1024, - "children": [547, 552] + "children": [568, 573] } ], "sources": [ @@ -32640,14 +33323,14 @@ { "type": "reflection", "declaration": { - "id": 553, + "id": 574, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 554, + "id": 575, "name": "data", "kind": 1024, "kindString": "Property", @@ -32662,14 +33345,14 @@ "type": { "type": "reflection", "declaration": { - "id": 555, + "id": 576, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 557, + "id": 578, "name": "session", "kind": 1024, "kindString": "Property", @@ -32687,7 +33370,7 @@ } }, { - "id": 556, + "id": 577, "name": "user", "kind": 1024, "kindString": "Property", @@ -32709,7 +33392,7 @@ { "title": "Properties", "kind": 1024, - "children": [557, 556] + "children": [578, 577] } ], "sources": [ @@ -32723,7 +33406,7 @@ } }, { - "id": 558, + "id": 579, "name": "error", "kind": 1024, "kindString": "Property", @@ -32737,7 +33420,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -32746,7 +33429,7 @@ { "title": "Properties", "kind": 1024, - "children": [554, 558] + "children": [575, 579] } ], "sources": [ @@ -32762,7 +33445,7 @@ } }, { - "id": 574, + "id": 595, "name": "AuthTokenResponse", "kind": 4194304, "kindString": "Type alias", @@ -32780,14 +33463,14 @@ { "type": "reflection", "declaration": { - "id": 575, + "id": 596, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 576, + "id": 597, "name": "data", "kind": 1024, "kindString": "Property", @@ -32802,14 +33485,14 @@ "type": { "type": "reflection", "declaration": { - "id": 577, + "id": 598, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 579, + "id": 600, "name": "session", "kind": 1024, "kindString": "Property", @@ -32823,12 +33506,12 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } }, { - "id": 578, + "id": 599, "name": "user", "kind": 1024, "kindString": "Property", @@ -32842,7 +33525,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -32851,7 +33534,7 @@ { "title": "Properties", "kind": 1024, - "children": [579, 578] + "children": [600, 599] } ], "sources": [ @@ -32865,7 +33548,7 @@ } }, { - "id": 580, + "id": 601, "name": "error", "kind": 1024, "kindString": "Property", @@ -32887,7 +33570,7 @@ { "title": "Properties", "kind": 1024, - "children": [576, 580] + "children": [597, 601] } ], "sources": [ @@ -32902,14 +33585,14 @@ { "type": "reflection", "declaration": { - "id": 581, + "id": 602, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 603, "name": "data", "kind": 1024, "kindString": "Property", @@ -32924,14 +33607,14 @@ "type": { "type": "reflection", "declaration": { - "id": 583, + "id": 604, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 585, + "id": 606, "name": "session", "kind": 1024, "kindString": "Property", @@ -32949,7 +33632,7 @@ } }, { - "id": 584, + "id": 605, "name": "user", "kind": 1024, "kindString": "Property", @@ -32971,7 +33654,7 @@ { "title": "Properties", "kind": 1024, - "children": [585, 584] + "children": [606, 605] } ], "sources": [ @@ -32985,7 +33668,7 @@ } }, { - "id": 586, + "id": 607, "name": "error", "kind": 1024, "kindString": "Property", @@ -32999,7 +33682,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -33008,7 +33691,7 @@ { "title": "Properties", "kind": 1024, - "children": [582, 586] + "children": [603, 607] } ], "sources": [ @@ -33024,7 +33707,7 @@ } }, { - "id": 587, + "id": 608, "name": "AuthTokenResponsePassword", "kind": 4194304, "kindString": "Type alias", @@ -33042,14 +33725,14 @@ { "type": "reflection", "declaration": { - "id": 588, + "id": 609, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 589, + "id": 610, "name": "data", "kind": 1024, "kindString": "Property", @@ -33064,14 +33747,14 @@ "type": { "type": "reflection", "declaration": { - "id": 590, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 592, + "id": 613, "name": "session", "kind": 1024, "kindString": "Property", @@ -33085,12 +33768,12 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } }, { - "id": 591, + "id": 612, "name": "user", "kind": 1024, "kindString": "Property", @@ -33104,12 +33787,12 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } }, { - "id": 593, + "id": 614, "name": "weakPassword", "kind": 1024, "kindString": "Property", @@ -33125,7 +33808,7 @@ ], "type": { "type": "reference", - "id": 528, + "id": 549, "name": "WeakPassword" } } @@ -33134,7 +33817,7 @@ { "title": "Properties", "kind": 1024, - "children": [592, 591, 593] + "children": [613, 612, 614] } ], "sources": [ @@ -33148,7 +33831,7 @@ } }, { - "id": 594, + "id": 615, "name": "error", "kind": 1024, "kindString": "Property", @@ -33170,7 +33853,7 @@ { "title": "Properties", "kind": 1024, - "children": [589, 594] + "children": [610, 615] } ], "sources": [ @@ -33185,14 +33868,14 @@ { "type": "reflection", "declaration": { - "id": 595, + "id": 616, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 596, + "id": 617, "name": "data", "kind": 1024, "kindString": "Property", @@ -33207,14 +33890,14 @@ "type": { "type": "reflection", "declaration": { - "id": 597, + "id": 618, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 599, + "id": 620, "name": "session", "kind": 1024, "kindString": "Property", @@ -33232,7 +33915,7 @@ } }, { - "id": 598, + "id": 619, "name": "user", "kind": 1024, "kindString": "Property", @@ -33250,7 +33933,7 @@ } }, { - "id": 600, + "id": 621, "name": "weakPassword", "kind": 1024, "kindString": "Property", @@ -33274,7 +33957,7 @@ { "title": "Properties", "kind": 1024, - "children": [599, 598, 600] + "children": [620, 619, 621] } ], "sources": [ @@ -33288,7 +33971,7 @@ } }, { - "id": 601, + "id": 622, "name": "error", "kind": 1024, "kindString": "Property", @@ -33302,7 +33985,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -33311,7 +33994,7 @@ { "title": "Properties", "kind": 1024, - "children": [596, 601] + "children": [617, 622] } ], "sources": [ @@ -33327,7 +34010,7 @@ } }, { - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -33354,7 +34037,7 @@ } }, { - "id": 1034, + "id": 1055, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -33372,14 +34055,14 @@ { "type": "reflection", "declaration": { - "id": 1035, + "id": 1056, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1037, + "id": 1058, "name": "error", "kind": 1024, "kindString": "Property", @@ -33397,7 +34080,7 @@ } }, { - "id": 1036, + "id": 1057, "name": "session", "kind": 1024, "kindString": "Property", @@ -33411,7 +34094,7 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } } @@ -33420,7 +34103,7 @@ { "title": "Properties", "kind": 1024, - "children": [1037, 1036] + "children": [1058, 1057] } ], "sources": [ @@ -33435,14 +34118,14 @@ { "type": "reflection", "declaration": { - "id": 1038, + "id": 1059, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1040, + "id": 1061, "name": "error", "kind": 1024, "kindString": "Property", @@ -33456,12 +34139,12 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } }, { - "id": 1039, + "id": 1060, "name": "session", "kind": 1024, "kindString": "Property", @@ -33483,7 +34166,7 @@ { "title": "Properties", "kind": 1024, - "children": [1040, 1039] + "children": [1061, 1060] } ], "sources": [ @@ -33499,7 +34182,7 @@ } }, { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -33542,7 +34225,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -33557,14 +34240,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -33585,7 +34268,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -33606,7 +34289,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -33625,7 +34308,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -33639,7 +34322,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -33670,7 +34353,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -33684,7 +34367,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -33699,14 +34382,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -33727,7 +34410,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -33746,7 +34429,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -33769,7 +34452,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -33800,7 +34483,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -33814,7 +34497,7 @@ } }, { - "id": 876, + "id": 897, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -33830,7 +34513,7 @@ "type": "union", "types": [ { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -33845,14 +34528,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -33870,7 +34553,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -33889,7 +34572,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -33912,7 +34595,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -33930,7 +34613,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -33952,7 +34635,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -33966,7 +34649,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -33981,14 +34664,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -34009,7 +34692,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -34028,7 +34711,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -34051,7 +34734,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -34082,7 +34765,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -34096,7 +34779,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -34111,14 +34794,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -34139,7 +34822,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -34158,7 +34841,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -34172,7 +34855,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -34194,7 +34877,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -34208,7 +34891,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -34223,14 +34906,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -34251,7 +34934,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -34272,7 +34955,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -34291,7 +34974,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -34305,7 +34988,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -34336,7 +35019,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -34353,7 +35036,7 @@ } }, { - "id": 890, + "id": 911, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -34371,14 +35054,14 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 913, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -34399,7 +35082,7 @@ } }, { - "id": 893, + "id": 914, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -34420,7 +35103,7 @@ } }, { - "id": 894, + "id": 915, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -34441,7 +35124,7 @@ } }, { - "id": 895, + "id": 916, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -34462,7 +35145,7 @@ } }, { - "id": 896, + "id": 917, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -34479,10 +35162,10 @@ ], "type": { "type": "reference", - "id": 897, + "id": 918, "name": "GenerateLinkType", "dereferenced": { - "id": 897, + "id": 918, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -34531,7 +35214,7 @@ { "title": "Properties", "kind": 1024, - "children": [892, 893, 894, 895, 896] + "children": [913, 914, 915, 916, 917] } ], "sources": [ @@ -34545,7 +35228,7 @@ } }, { - "id": 877, + "id": 898, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -34563,14 +35246,14 @@ { "type": "reflection", "declaration": { - "id": 878, + "id": 899, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 900, "name": "data", "kind": 1024, "kindString": "Property", @@ -34585,14 +35268,14 @@ "type": { "type": "reflection", "declaration": { - "id": 880, + "id": 901, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 881, + "id": 902, "name": "properties", "kind": 1024, "kindString": "Property", @@ -34606,12 +35289,12 @@ ], "type": { "type": "reference", - "id": 890, + "id": 911, "name": "GenerateLinkProperties" } }, { - "id": 882, + "id": 903, "name": "user", "kind": 1024, "kindString": "Property", @@ -34625,7 +35308,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -34634,7 +35317,7 @@ { "title": "Properties", "kind": 1024, - "children": [881, 882] + "children": [902, 903] } ], "sources": [ @@ -34648,7 +35331,7 @@ } }, { - "id": 883, + "id": 904, "name": "error", "kind": 1024, "kindString": "Property", @@ -34670,7 +35353,7 @@ { "title": "Properties", "kind": 1024, - "children": [879, 883] + "children": [900, 904] } ], "sources": [ @@ -34685,14 +35368,14 @@ { "type": "reflection", "declaration": { - "id": 884, + "id": 905, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 885, + "id": 906, "name": "data", "kind": 1024, "kindString": "Property", @@ -34707,14 +35390,14 @@ "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 907, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 887, + "id": 908, "name": "properties", "kind": 1024, "kindString": "Property", @@ -34732,7 +35415,7 @@ } }, { - "id": 888, + "id": 909, "name": "user", "kind": 1024, "kindString": "Property", @@ -34754,7 +35437,7 @@ { "title": "Properties", "kind": 1024, - "children": [887, 888] + "children": [908, 909] } ], "sources": [ @@ -34768,7 +35451,7 @@ } }, { - "id": 889, + "id": 910, "name": "error", "kind": 1024, "kindString": "Property", @@ -34782,7 +35465,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -34791,7 +35474,7 @@ { "title": "Properties", "kind": 1024, - "children": [885, 889] + "children": [906, 910] } ], "sources": [ @@ -34807,7 +35490,7 @@ } }, { - "id": 897, + "id": 918, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -34850,7 +35533,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -34865,14 +35548,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -34893,7 +35576,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -34912,7 +35595,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -34926,7 +35609,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -34948,7 +35631,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -34962,7 +35645,7 @@ } }, { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -34977,14 +35660,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -35002,7 +35685,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -35021,7 +35704,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -35044,7 +35727,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -35062,7 +35745,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -35084,7 +35767,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -35098,7 +35781,7 @@ } }, { - "id": 505, + "id": 526, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -35113,14 +35796,14 @@ "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 535, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -35140,7 +35823,7 @@ } }, { - "id": 519, + "id": 540, "name": "debug", "kind": 1024, "kindString": "Property", @@ -35164,7 +35847,7 @@ { "type": "reflection", "declaration": { - "id": 520, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -35178,14 +35861,14 @@ ], "signatures": [ { - "id": 521, + "id": 542, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 522, + "id": 543, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -35196,7 +35879,7 @@ } }, { - "id": 523, + "id": 544, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -35224,7 +35907,7 @@ } }, { - "id": 513, + "id": 534, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -35244,7 +35927,7 @@ } }, { - "id": 517, + "id": 538, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -35264,7 +35947,7 @@ } }, { - "id": 518, + "id": 539, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -35280,10 +35963,10 @@ ], "type": { "type": "reference", - "id": 779, + "id": 800, "name": "AuthFlowType", "dereferenced": { - "id": 779, + "id": 800, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -35312,7 +35995,7 @@ } }, { - "id": 525, + "id": 546, "name": "hasCustomAuthorizationHeader", "kind": 1024, "kindString": "Property", @@ -35341,7 +36024,7 @@ } }, { - "id": 508, + "id": 529, "name": "headers", "kind": 1024, "kindString": "Property", @@ -35358,7 +36041,7 @@ "type": { "type": "reflection", "declaration": { - "id": 509, + "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -35371,14 +36054,14 @@ } ], "indexSignature": { - "id": 510, + "id": 531, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 511, + "id": 532, "name": "key", "kind": 32768, "flags": {}, @@ -35397,7 +36080,7 @@ } }, { - "id": 524, + "id": 545, "name": "lock", "kind": 1024, "kindString": "Property", @@ -35422,10 +36105,10 @@ ], "type": { "type": "reference", - "id": 496, + "id": 517, "name": "LockFunc", "dereferenced": { - "id": 496, + "id": 517, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -35440,7 +36123,7 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -35454,7 +36137,7 @@ ], "signatures": [ { - "id": 498, + "id": 519, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -35470,7 +36153,7 @@ }, "typeParameter": [ { - "id": 504, + "id": 525, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -35479,7 +36162,7 @@ ], "parameters": [ { - "id": 499, + "id": 520, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -35493,7 +36176,7 @@ } }, { - "id": 500, + "id": 521, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -35507,7 +36190,7 @@ } }, { - "id": 501, + "id": 522, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -35518,7 +36201,7 @@ "type": { "type": "reflection", "declaration": { - "id": 502, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -35532,7 +36215,7 @@ ], "signatures": [ { - "id": 503, + "id": 524, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -35542,7 +36225,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -35561,7 +36244,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -35577,7 +36260,7 @@ } }, { - "id": 515, + "id": 536, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -35597,7 +36280,7 @@ } }, { - "id": 516, + "id": 537, "name": "storage", "kind": 1024, "kindString": "Property", @@ -35613,10 +36296,10 @@ ], "type": { "type": "reference", - "id": 1028, + "id": 1049, "name": "SupportedStorage", "dereferenced": { - "id": 1028, + "id": 1049, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -35671,14 +36354,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1050, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1030, + "id": 1051, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -35705,7 +36388,7 @@ { "title": "Properties", "kind": 1024, - "children": [1030] + "children": [1051] } ], "sources": [ @@ -35723,7 +36406,7 @@ } }, { - "id": 512, + "id": 533, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -35743,7 +36426,7 @@ } }, { - "id": 507, + "id": 528, "name": "url", "kind": 1024, "kindString": "Property", @@ -35767,7 +36450,7 @@ { "title": "Properties", "kind": 1024, - "children": [514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507] + "children": [535, 540, 534, 538, 539, 546, 529, 545, 536, 537, 533, 528] } ], "sources": [ @@ -35781,7 +36464,7 @@ } }, { - "id": 1031, + "id": 1052, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -35796,14 +36479,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1032, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1033, + "id": 1054, "name": "error", "kind": 1024, "kindString": "Property", @@ -35820,7 +36503,7 @@ "types": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" }, { @@ -35835,7 +36518,7 @@ { "title": "Properties", "kind": 1024, - "children": [1033] + "children": [1054] } ], "sources": [ @@ -35849,7 +36532,178 @@ } }, { - "id": 496, + "id": 1114, + "name": "JwtHeader", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1203, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1115, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1116, + "name": "alg", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1204, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "RS256" + }, + { + "type": "literal", + "value": "ES256" + }, + { + "type": "literal", + "value": "HS256" + } + ] + } + }, + { + "id": 1117, + "name": "kid", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1205, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1118, + "name": "typ", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1206, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1116, 1117, 1118] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1203, + "character": 24 + } + ] + } + } + }, + { + "id": 1129, + "name": "JwtPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1220, + "character": 12 + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "id": 1119, + "name": "RequiredClaims" + }, + { + "type": "reflection", + "declaration": { + "id": 1130, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1220, + "character": 42 + } + ], + "indexSignature": { + "id": 1131, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 1132, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + ] + } + }, + { + "id": 517, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -35864,7 +36718,7 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -35878,7 +36732,7 @@ ], "signatures": [ { - "id": 498, + "id": 519, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -35894,7 +36748,7 @@ }, "typeParameter": [ { - "id": 504, + "id": 525, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -35903,7 +36757,7 @@ ], "parameters": [ { - "id": 499, + "id": 520, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -35917,7 +36771,7 @@ } }, { - "id": 500, + "id": 521, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -35931,7 +36785,7 @@ } }, { - "id": 501, + "id": 522, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -35942,7 +36796,7 @@ "type": { "type": "reflection", "declaration": { - "id": 502, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -35956,7 +36810,7 @@ ], "signatures": [ { - "id": 503, + "id": 524, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -35966,7 +36820,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -35985,7 +36839,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -35999,7 +36853,7 @@ } }, { - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -36014,14 +36868,14 @@ "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 933, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 914, + "id": 935, "name": "code", "kind": 1024, "kindString": "Property", @@ -36042,7 +36896,7 @@ } }, { - "id": 913, + "id": 934, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -36067,7 +36921,7 @@ { "title": "Properties", "kind": 1024, - "children": [914, 913] + "children": [935, 934] } ], "sources": [ @@ -36081,7 +36935,7 @@ } }, { - "id": 907, + "id": 928, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -36096,14 +36950,14 @@ "type": { "type": "reflection", "declaration": { - "id": 908, + "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 910, + "id": 931, "name": "channel", "kind": 1024, "kindString": "Property", @@ -36135,7 +36989,7 @@ } }, { - "id": 909, + "id": 930, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -36160,7 +37014,7 @@ { "title": "Properties", "kind": 1024, - "children": [910, 909] + "children": [931, 930] } ], "sources": [ @@ -36174,7 +37028,7 @@ } }, { - "id": 898, + "id": 919, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -36190,7 +37044,7 @@ "type": "union", "types": [ { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -36205,14 +37059,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -36233,7 +37087,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -36256,7 +37110,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -36283,7 +37137,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -36297,7 +37151,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -36312,14 +37166,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -36340,7 +37194,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -36363,7 +37217,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -36388,7 +37242,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -36405,7 +37259,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -36420,14 +37274,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -36448,7 +37302,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -36471,7 +37325,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -36496,7 +37350,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -36510,7 +37364,7 @@ } }, { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -36525,14 +37379,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -36553,7 +37407,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -36576,7 +37430,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -36603,7 +37457,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -36617,7 +37471,7 @@ } }, { - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -36632,14 +37486,14 @@ "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 922, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -36664,7 +37518,7 @@ { "title": "Properties", "kind": 1024, - "children": [901] + "children": [922] } ], "sources": [ @@ -36678,7 +37532,7 @@ } }, { - "id": 902, + "id": 923, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -36693,14 +37547,14 @@ "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 924, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 926, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -36721,7 +37575,7 @@ } }, { - "id": 906, + "id": 927, "name": "code", "kind": 1024, "kindString": "Property", @@ -36742,7 +37596,7 @@ } }, { - "id": 904, + "id": 925, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -36767,7 +37621,7 @@ { "title": "Properties", "kind": 1024, - "children": [905, 906, 904] + "children": [926, 927, 925] } ], "sources": [ @@ -36781,7 +37635,7 @@ } }, { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -36808,7 +37662,7 @@ } }, { - "id": 602, + "id": 623, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -36826,14 +37680,14 @@ { "type": "reflection", "declaration": { - "id": 603, + "id": 624, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 604, + "id": 625, "name": "data", "kind": 1024, "kindString": "Property", @@ -36848,14 +37702,14 @@ "type": { "type": "reflection", "declaration": { - "id": 605, + "id": 626, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 606, + "id": 627, "name": "provider", "kind": 1024, "kindString": "Property", @@ -36869,12 +37723,12 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider" } }, { - "id": 607, + "id": 628, "name": "url", "kind": 1024, "kindString": "Property", @@ -36896,7 +37750,7 @@ { "title": "Properties", "kind": 1024, - "children": [606, 607] + "children": [627, 628] } ], "sources": [ @@ -36910,7 +37764,7 @@ } }, { - "id": 608, + "id": 629, "name": "error", "kind": 1024, "kindString": "Property", @@ -36932,7 +37786,7 @@ { "title": "Properties", "kind": 1024, - "children": [604, 608] + "children": [625, 629] } ], "sources": [ @@ -36947,14 +37801,14 @@ { "type": "reflection", "declaration": { - "id": 609, + "id": 630, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 610, + "id": 631, "name": "data", "kind": 1024, "kindString": "Property", @@ -36969,14 +37823,14 @@ "type": { "type": "reflection", "declaration": { - "id": 611, + "id": 632, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 612, + "id": 633, "name": "provider", "kind": 1024, "kindString": "Property", @@ -36990,12 +37844,12 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider" } }, { - "id": 613, + "id": 634, "name": "url", "kind": 1024, "kindString": "Property", @@ -37017,7 +37871,7 @@ { "title": "Properties", "kind": 1024, - "children": [612, 613] + "children": [633, 634] } ], "sources": [ @@ -37031,7 +37885,7 @@ } }, { - "id": 614, + "id": 635, "name": "error", "kind": 1024, "kindString": "Property", @@ -37045,7 +37899,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -37054,7 +37908,7 @@ { "title": "Properties", "kind": 1024, - "children": [610, 614] + "children": [631, 635] } ], "sources": [ @@ -37070,7 +37924,7 @@ } }, { - "id": 1048, + "id": 1069, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -37085,14 +37939,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1070, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1071, "name": "page", "kind": 1024, "kindString": "Property", @@ -37115,7 +37969,7 @@ } }, { - "id": 1051, + "id": 1072, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -37142,7 +37996,7 @@ { "title": "Properties", "kind": 1024, - "children": [1050, 1051] + "children": [1071, 1072] } ], "sources": [ @@ -37156,7 +38010,7 @@ } }, { - "id": 1041, + "id": 1062, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -37171,14 +38025,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1042, + "id": 1063, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1044, + "id": 1065, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -37196,7 +38050,7 @@ } }, { - "id": 1043, + "id": 1064, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -37223,7 +38077,7 @@ } }, { - "id": 1045, + "id": 1066, "name": "total", "kind": 1024, "kindString": "Property", @@ -37245,7 +38099,7 @@ { "title": "Properties", "kind": 1024, - "children": [1044, 1043, 1045] + "children": [1065, 1064, 1066] } ], "sources": [ @@ -37256,14 +38110,14 @@ } ], "indexSignature": { - "id": 1046, + "id": 1067, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1047, + "id": 1068, "name": "key", "kind": 32768, "flags": {}, @@ -37282,7 +38136,7 @@ } }, { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -37392,7 +38246,231 @@ } }, { - "id": 824, + "id": 1119, + "name": "RequiredClaims", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1209, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1120, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1127, + "name": "aal", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1216, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 981, + "name": "AuthenticatorAssuranceLevels", + "dereferenced": { + "id": 981, + "name": "AuthenticatorAssuranceLevels", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 903, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "aal1" + }, + { + "type": "literal", + "value": "aal2" + } + ] + } + } + } + }, + { + "id": 1123, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1212, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1124, + "name": "exp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1213, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1125, + "name": "iat", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1214, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1121, + "name": "iss", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1126, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1215, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1128, + "name": "session_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1217, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1122, + "name": "sub", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1211, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1127, 1123, 1124, 1125, 1121, 1126, 1128, 1122] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1209, + "character": 29 + } + ] + } + } + }, + { + "id": 845, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -37410,14 +38488,14 @@ { "type": "reflection", "declaration": { - "id": 825, + "id": 846, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 827, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", @@ -37435,7 +38513,7 @@ } }, { - "id": 828, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -37452,14 +38530,14 @@ "type": { "type": "reflection", "declaration": { - "id": 829, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 831, + "id": 852, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37482,7 +38560,7 @@ } }, { - "id": 830, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -37509,7 +38587,7 @@ { "title": "Properties", "kind": 1024, - "children": [831, 830] + "children": [852, 851] } ], "sources": [ @@ -37523,7 +38601,7 @@ } }, { - "id": 826, + "id": 847, "name": "type", "kind": 1024, "kindString": "Property", @@ -37540,7 +38618,7 @@ "typeArguments": [ { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType" }, { @@ -37567,7 +38645,7 @@ { "title": "Properties", "kind": 1024, - "children": [827, 828, 826] + "children": [848, 849, 847] } ], "sources": [ @@ -37582,14 +38660,14 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 853, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -37606,14 +38684,14 @@ "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 857, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 858, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37640,7 +38718,7 @@ { "title": "Properties", "kind": 1024, - "children": [837] + "children": [858] } ], "sources": [ @@ -37654,7 +38732,7 @@ } }, { - "id": 834, + "id": 855, "name": "phone", "kind": 1024, "kindString": "Property", @@ -37672,7 +38750,7 @@ } }, { - "id": 833, + "id": 854, "name": "type", "kind": 1024, "kindString": "Property", @@ -37689,7 +38767,7 @@ "typeArguments": [ { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType" }, { @@ -37716,7 +38794,7 @@ { "title": "Properties", "kind": 1024, - "children": [835, 834, 833] + "children": [856, 855, 854] } ], "sources": [ @@ -37732,7 +38810,7 @@ } }, { - "id": 615, + "id": 636, "name": "SSOResponse", "kind": 4194304, "kindString": "Type alias", @@ -37750,14 +38828,14 @@ { "type": "reflection", "declaration": { - "id": 616, + "id": 637, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 638, "name": "data", "kind": 1024, "kindString": "Property", @@ -37772,14 +38850,14 @@ "type": { "type": "reflection", "declaration": { - "id": 618, + "id": 639, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 619, + "id": 640, "name": "url", "kind": 1024, "kindString": "Property", @@ -37805,7 +38883,7 @@ { "title": "Properties", "kind": 1024, - "children": [619] + "children": [640] } ], "sources": [ @@ -37819,7 +38897,7 @@ } }, { - "id": 620, + "id": 641, "name": "error", "kind": 1024, "kindString": "Property", @@ -37841,7 +38919,7 @@ { "title": "Properties", "kind": 1024, - "children": [617, 620] + "children": [638, 641] } ], "sources": [ @@ -37856,14 +38934,14 @@ { "type": "reflection", "declaration": { - "id": 621, + "id": 642, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 643, "name": "data", "kind": 1024, "kindString": "Property", @@ -37881,7 +38959,7 @@ } }, { - "id": 623, + "id": 644, "name": "error", "kind": 1024, "kindString": "Property", @@ -37895,7 +38973,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -37904,7 +38982,7 @@ { "title": "Properties", "kind": 1024, - "children": [622, 623] + "children": [643, 644] } ], "sources": [ @@ -37920,7 +38998,7 @@ } }, { - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -37935,14 +39013,14 @@ "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 748, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 728, + "id": 749, "name": "options", "kind": 1024, "kindString": "Property", @@ -37959,14 +39037,14 @@ "type": { "type": "reflection", "declaration": { - "id": 729, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 752, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37989,7 +39067,7 @@ } }, { - "id": 730, + "id": 751, "name": "data", "kind": 1024, "kindString": "Property", @@ -38017,7 +39095,7 @@ { "title": "Properties", "kind": 1024, - "children": [731, 730] + "children": [752, 751] } ], "sources": [ @@ -38035,7 +39113,7 @@ { "title": "Properties", "kind": 1024, - "children": [728] + "children": [749] } ], "sources": [ @@ -38049,7 +39127,7 @@ } }, { - "id": 792, + "id": 813, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -38064,14 +39142,14 @@ "type": { "type": "reflection", "declaration": { - "id": 793, + "id": 814, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -38094,7 +39172,7 @@ } }, { - "id": 798, + "id": 819, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -38117,7 +39195,7 @@ } }, { - "id": 799, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -38134,14 +39212,14 @@ "type": { "type": "reflection", "declaration": { - "id": 800, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 801, + "id": 822, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -38168,7 +39246,7 @@ { "title": "Properties", "kind": 1024, - "children": [801] + "children": [822] } ], "sources": [ @@ -38182,7 +39260,7 @@ } }, { - "id": 794, + "id": 815, "name": "provider", "kind": 1024, "kindString": "Property", @@ -38230,7 +39308,7 @@ { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -38250,7 +39328,7 @@ } }, { - "id": 796, + "id": 817, "name": "token", "kind": 1024, "kindString": "Property", @@ -38275,7 +39353,7 @@ { "title": "Properties", "kind": 1024, - "children": [797, 798, 799, 794, 796] + "children": [818, 819, 820, 815, 817] } ], "sources": [ @@ -38289,7 +39367,7 @@ } }, { - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -38304,14 +39382,14 @@ "type": { "type": "reflection", "declaration": { - "id": 781, + "id": 802, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 783, + "id": 804, "name": "options", "kind": 1024, "kindString": "Property", @@ -38328,14 +39406,14 @@ "type": { "type": "reflection", "declaration": { - "id": 784, + "id": 805, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 787, + "id": 808, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -38355,7 +39433,7 @@ "type": { "type": "reflection", "declaration": { - "id": 788, + "id": 809, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -38368,14 +39446,14 @@ } ], "indexSignature": { - "id": 789, + "id": 810, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 790, + "id": 811, "name": "key", "kind": 32768, "flags": {}, @@ -38394,7 +39472,7 @@ } }, { - "id": 785, + "id": 806, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -38417,7 +39495,7 @@ } }, { - "id": 786, + "id": 807, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -38440,7 +39518,7 @@ } }, { - "id": 791, + "id": 812, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -38467,7 +39545,7 @@ { "title": "Properties", "kind": 1024, - "children": [787, 785, 786, 791] + "children": [808, 806, 807, 812] } ], "sources": [ @@ -38481,7 +39559,7 @@ } }, { - "id": 782, + "id": 803, "name": "provider", "kind": 1024, "kindString": "Property", @@ -38498,10 +39576,10 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider", "dereferenced": { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -38617,7 +39695,7 @@ { "title": "Properties", "kind": 1024, - "children": [783, 782] + "children": [804, 803] } ], "sources": [ @@ -38631,7 +39709,7 @@ } }, { - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -38649,14 +39727,14 @@ { "type": "reflection", "declaration": { - "id": 750, + "id": 771, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 751, + "id": 772, "name": "email", "kind": 1024, "kindString": "Property", @@ -38677,7 +39755,7 @@ } }, { - "id": 753, + "id": 774, "name": "options", "kind": 1024, "kindString": "Property", @@ -38694,14 +39772,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 775, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 755, + "id": 776, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -38728,7 +39806,7 @@ { "title": "Properties", "kind": 1024, - "children": [755] + "children": [776] } ], "sources": [ @@ -38742,7 +39820,7 @@ } }, { - "id": 752, + "id": 773, "name": "password", "kind": 1024, "kindString": "Property", @@ -38767,7 +39845,7 @@ { "title": "Properties", "kind": 1024, - "children": [751, 753, 752] + "children": [772, 774, 773] } ], "sources": [ @@ -38782,14 +39860,14 @@ { "type": "reflection", "declaration": { - "id": 756, + "id": 777, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 759, + "id": 780, "name": "options", "kind": 1024, "kindString": "Property", @@ -38806,14 +39884,14 @@ "type": { "type": "reflection", "declaration": { - "id": 760, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 782, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -38840,7 +39918,7 @@ { "title": "Properties", "kind": 1024, - "children": [761] + "children": [782] } ], "sources": [ @@ -38854,7 +39932,7 @@ } }, { - "id": 758, + "id": 779, "name": "password", "kind": 1024, "kindString": "Property", @@ -38875,7 +39953,7 @@ } }, { - "id": 757, + "id": 778, "name": "phone", "kind": 1024, "kindString": "Property", @@ -38900,7 +39978,7 @@ { "title": "Properties", "kind": 1024, - "children": [759, 758, 757] + "children": [780, 779, 778] } ], "sources": [ @@ -38916,7 +39994,7 @@ } }, { - "id": 762, + "id": 783, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -38934,14 +40012,14 @@ { "type": "reflection", "declaration": { - "id": 763, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 764, + "id": 785, "name": "email", "kind": 1024, "kindString": "Property", @@ -38962,7 +40040,7 @@ } }, { - "id": 765, + "id": 786, "name": "options", "kind": 1024, "kindString": "Property", @@ -38979,14 +40057,14 @@ "type": { "type": "reflection", "declaration": { - "id": 766, + "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 770, + "id": 791, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -39009,7 +40087,7 @@ } }, { - "id": 769, + "id": 790, "name": "data", "kind": 1024, "kindString": "Property", @@ -39033,7 +40111,7 @@ } }, { - "id": 767, + "id": 788, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -39056,7 +40134,7 @@ } }, { - "id": 768, + "id": 789, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -39083,7 +40161,7 @@ { "title": "Properties", "kind": 1024, - "children": [770, 769, 767, 768] + "children": [791, 790, 788, 789] } ], "sources": [ @@ -39101,7 +40179,7 @@ { "title": "Properties", "kind": 1024, - "children": [764, 765] + "children": [785, 786] } ], "sources": [ @@ -39116,14 +40194,14 @@ { "type": "reflection", "declaration": { - "id": 771, + "id": 792, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 773, + "id": 794, "name": "options", "kind": 1024, "kindString": "Property", @@ -39140,14 +40218,14 @@ "type": { "type": "reflection", "declaration": { - "id": 774, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 777, + "id": 798, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -39170,7 +40248,7 @@ } }, { - "id": 778, + "id": 799, "name": "channel", "kind": 1024, "kindString": "Property", @@ -39202,7 +40280,7 @@ } }, { - "id": 776, + "id": 797, "name": "data", "kind": 1024, "kindString": "Property", @@ -39226,7 +40304,7 @@ } }, { - "id": 775, + "id": 796, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -39253,7 +40331,7 @@ { "title": "Properties", "kind": 1024, - "children": [777, 778, 776, 775] + "children": [798, 799, 797, 796] } ], "sources": [ @@ -39267,7 +40345,7 @@ } }, { - "id": 772, + "id": 793, "name": "phone", "kind": 1024, "kindString": "Property", @@ -39292,7 +40370,7 @@ { "title": "Properties", "kind": 1024, - "children": [773, 772] + "children": [794, 793] } ], "sources": [ @@ -39308,7 +40386,7 @@ } }, { - "id": 838, + "id": 859, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -39326,14 +40404,14 @@ { "type": "reflection", "declaration": { - "id": 839, + "id": 860, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 862, "name": "options", "kind": 1024, "kindString": "Property", @@ -39350,14 +40428,14 @@ "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -39380,7 +40458,7 @@ } }, { - "id": 843, + "id": 864, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -39407,7 +40485,7 @@ { "title": "Properties", "kind": 1024, - "children": [844, 843] + "children": [865, 864] } ], "sources": [ @@ -39421,7 +40499,7 @@ } }, { - "id": 840, + "id": 861, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -39446,7 +40524,7 @@ { "title": "Properties", "kind": 1024, - "children": [841, 840] + "children": [862, 861] } ], "sources": [ @@ -39461,14 +40539,14 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 866, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 867, "name": "domain", "kind": 1024, "kindString": "Property", @@ -39489,7 +40567,7 @@ } }, { - "id": 847, + "id": 868, "name": "options", "kind": 1024, "kindString": "Property", @@ -39506,14 +40584,14 @@ "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 869, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 850, + "id": 871, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -39536,7 +40614,7 @@ } }, { - "id": 849, + "id": 870, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -39563,7 +40641,7 @@ { "title": "Properties", "kind": 1024, - "children": [850, 849] + "children": [871, 870] } ], "sources": [ @@ -39581,7 +40659,7 @@ { "title": "Properties", "kind": 1024, - "children": [846, 847] + "children": [867, 868] } ], "sources": [ @@ -39597,7 +40675,7 @@ } }, { - "id": 1052, + "id": 1073, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -39612,14 +40690,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1053, + "id": 1074, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1054, + "id": 1075, "name": "scope", "kind": 1024, "kindString": "Property", @@ -39659,7 +40737,7 @@ { "title": "Properties", "kind": 1024, - "children": [1054] + "children": [1075] } ], "sources": [ @@ -39673,7 +40751,7 @@ } }, { - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -39691,14 +40769,14 @@ { "type": "reflection", "declaration": { - "id": 733, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 734, + "id": 755, "name": "email", "kind": 1024, "kindString": "Property", @@ -39719,7 +40797,7 @@ } }, { - "id": 736, + "id": 757, "name": "options", "kind": 1024, "kindString": "Property", @@ -39736,14 +40814,14 @@ "type": { "type": "reflection", "declaration": { - "id": 737, + "id": 758, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 740, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -39766,7 +40844,7 @@ } }, { - "id": 739, + "id": 760, "name": "data", "kind": 1024, "kindString": "Property", @@ -39790,7 +40868,7 @@ } }, { - "id": 738, + "id": 759, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -39817,7 +40895,7 @@ { "title": "Properties", "kind": 1024, - "children": [740, 739, 738] + "children": [761, 760, 759] } ], "sources": [ @@ -39831,7 +40909,7 @@ } }, { - "id": 735, + "id": 756, "name": "password", "kind": 1024, "kindString": "Property", @@ -39856,7 +40934,7 @@ { "title": "Properties", "kind": 1024, - "children": [734, 736, 735] + "children": [755, 757, 756] } ], "sources": [ @@ -39871,14 +40949,14 @@ { "type": "reflection", "declaration": { - "id": 741, + "id": 762, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -39895,14 +40973,14 @@ "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 747, + "id": 768, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -39925,7 +41003,7 @@ } }, { - "id": 748, + "id": 769, "name": "channel", "kind": 1024, "kindString": "Property", @@ -39957,7 +41035,7 @@ } }, { - "id": 746, + "id": 767, "name": "data", "kind": 1024, "kindString": "Property", @@ -39985,7 +41063,7 @@ { "title": "Properties", "kind": 1024, - "children": [747, 748, 746] + "children": [768, 769, 767] } ], "sources": [ @@ -39999,7 +41077,7 @@ } }, { - "id": 743, + "id": 764, "name": "password", "kind": 1024, "kindString": "Property", @@ -40020,7 +41098,7 @@ } }, { - "id": 742, + "id": 763, "name": "phone", "kind": 1024, "kindString": "Property", @@ -40045,7 +41123,7 @@ { "title": "Properties", "kind": 1024, - "children": [744, 743, 742] + "children": [765, 764, 763] } ], "sources": [ @@ -40061,7 +41139,7 @@ } }, { - "id": 1028, + "id": 1049, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -40116,14 +41194,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1050, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1030, + "id": 1051, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -40150,7 +41228,7 @@ { "title": "Properties", "kind": 1024, - "children": [1030] + "children": [1051] } ], "sources": [ @@ -40166,7 +41244,7 @@ } }, { - "id": 624, + "id": 645, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -40184,14 +41262,14 @@ { "type": "reflection", "declaration": { - "id": 625, + "id": 646, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 647, "name": "data", "kind": 1024, "kindString": "Property", @@ -40206,14 +41284,14 @@ "type": { "type": "reflection", "declaration": { - "id": 627, + "id": 648, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 628, + "id": 649, "name": "user", "kind": 1024, "kindString": "Property", @@ -40227,7 +41305,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -40236,7 +41314,7 @@ { "title": "Properties", "kind": 1024, - "children": [628] + "children": [649] } ], "sources": [ @@ -40250,7 +41328,7 @@ } }, { - "id": 629, + "id": 650, "name": "error", "kind": 1024, "kindString": "Property", @@ -40272,7 +41350,7 @@ { "title": "Properties", "kind": 1024, - "children": [626, 629] + "children": [647, 650] } ], "sources": [ @@ -40287,14 +41365,14 @@ { "type": "reflection", "declaration": { - "id": 630, + "id": 651, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 631, + "id": 652, "name": "data", "kind": 1024, "kindString": "Property", @@ -40309,14 +41387,14 @@ "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 653, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 633, + "id": 654, "name": "user", "kind": 1024, "kindString": "Property", @@ -40338,7 +41416,7 @@ { "title": "Properties", "kind": 1024, - "children": [633] + "children": [654] } ], "sources": [ @@ -40352,7 +41430,7 @@ } }, { - "id": 634, + "id": 655, "name": "error", "kind": 1024, "kindString": "Property", @@ -40366,7 +41444,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -40375,7 +41453,7 @@ { "title": "Properties", "kind": 1024, - "children": [631, 634] + "children": [652, 655] } ], "sources": [ @@ -40391,7 +41469,7 @@ } }, { - "id": 802, + "id": 823, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -40407,14 +41485,14 @@ "type": "union", "types": [ { - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -40431,14 +41509,14 @@ "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -40467,7 +41545,7 @@ } }, { - "id": 809, + "id": 830, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -40494,14 +41572,14 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ] } } }, { - "id": 804, + "id": 825, "name": "phone", "kind": 1024, "kindString": "Property", @@ -40522,7 +41600,7 @@ } }, { - "id": 805, + "id": 826, "name": "token", "kind": 1024, "kindString": "Property", @@ -40543,7 +41621,7 @@ } }, { - "id": 806, + "id": 827, "name": "type", "kind": 1024, "kindString": "Property", @@ -40560,10 +41638,10 @@ ], "type": { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType", "dereferenced": { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -40596,7 +41674,7 @@ { "title": "Properties", "kind": 1024, - "children": [807, 804, 805, 806] + "children": [828, 825, 826, 827] } ], "sources": [ @@ -40608,14 +41686,14 @@ ] }, { - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 812, + "id": 833, "name": "email", "kind": 1024, "kindString": "Property", @@ -40636,7 +41714,7 @@ } }, { - "id": 815, + "id": 836, "name": "options", "kind": 1024, "kindString": "Property", @@ -40653,14 +41731,14 @@ "type": { "type": "reflection", "declaration": { - "id": 816, + "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 818, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -40689,7 +41767,7 @@ } }, { - "id": 817, + "id": 838, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -40716,14 +41794,14 @@ { "title": "Properties", "kind": 1024, - "children": [818, 817] + "children": [839, 838] } ] } } }, { - "id": 813, + "id": 834, "name": "token", "kind": 1024, "kindString": "Property", @@ -40744,7 +41822,7 @@ } }, { - "id": 814, + "id": 835, "name": "type", "kind": 1024, "kindString": "Property", @@ -40761,10 +41839,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -40813,7 +41891,7 @@ { "title": "Properties", "kind": 1024, - "children": [812, 815, 813, 814] + "children": [833, 836, 834, 835] } ], "sources": [ @@ -40825,14 +41903,14 @@ ] }, { - "id": 819, + "id": 840, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -40853,7 +41931,7 @@ } }, { - "id": 821, + "id": 842, "name": "type", "kind": 1024, "kindString": "Property", @@ -40870,10 +41948,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -40922,7 +42000,7 @@ { "title": "Properties", "kind": 1024, - "children": [820, 821] + "children": [841, 842] } ], "sources": [ @@ -40937,7 +42015,7 @@ } }, { - "id": 528, + "id": 549, "name": "WeakPassword", "kind": 4194304, "kindString": "Type alias", @@ -40952,14 +42030,14 @@ "type": { "type": "reflection", "declaration": { - "id": 529, + "id": 550, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 552, "name": "message", "kind": 1024, "kindString": "Property", @@ -40977,7 +42055,7 @@ } }, { - "id": 530, + "id": 551, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -40993,7 +42071,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 526, + "id": 547, "name": "WeakPasswordReasons" } } @@ -41003,7 +42081,7 @@ { "title": "Properties", "kind": 1024, - "children": [531, 530] + "children": [552, 551] } ], "sources": [ @@ -41017,7 +42095,7 @@ } }, { - "id": 526, + "id": 547, "name": "WeakPasswordReasons", "kind": 4194304, "kindString": "Type alias", @@ -41054,7 +42132,7 @@ { "type": "reflection", "declaration": { - "id": 527, + "id": 548, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -41074,7 +42152,7 @@ } }, { - "id": 475, + "id": 496, "name": "AuthAdminApi", "kind": 32, "kindString": "Variable", @@ -41099,7 +42177,7 @@ "defaultValue": "GoTrueAdminApi" }, { - "id": 476, + "id": 497, "name": "AuthClient", "kind": 32, "kindString": "Variable", @@ -41124,7 +42202,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 490, + "id": 511, "name": "lockInternals", "kind": 32, "kindString": "Variable", @@ -41149,14 +42227,14 @@ "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 512, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 492, + "id": 513, "name": "debug", "kind": 1024, "kindString": "Property", @@ -41187,7 +42265,7 @@ { "title": "Properties", "kind": 1024, - "children": [492] + "children": [513] } ] } @@ -41195,7 +42273,7 @@ "defaultValue": "..." }, { - "id": 1096, + "id": 1143, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -41209,14 +42287,14 @@ ], "signatures": [ { - "id": 1097, + "id": 1144, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1098, + "id": 1145, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -41233,7 +42311,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1121, + "id": 1168, "name": "AuthApiError" } } @@ -41241,7 +42319,7 @@ ] }, { - "id": 1093, + "id": 1140, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -41255,14 +42333,14 @@ ], "signatures": [ { - "id": 1094, + "id": 1141, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1095, + "id": 1142, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -41279,7 +42357,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -41287,7 +42365,7 @@ ] }, { - "id": 1102, + "id": 1149, "name": "isAuthImplicitGrantRedirectError", "kind": 64, "kindString": "Function", @@ -41301,14 +42379,14 @@ ], "signatures": [ { - "id": 1103, + "id": 1150, "name": "isAuthImplicitGrantRedirectError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1104, + "id": 1151, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -41325,7 +42403,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1178, + "id": 1225, "name": "AuthImplicitGrantRedirectError" } } @@ -41333,7 +42411,7 @@ ] }, { - "id": 1105, + "id": 1152, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -41347,14 +42425,14 @@ ], "signatures": [ { - "id": 1106, + "id": 1153, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1107, + "id": 1154, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -41371,7 +42449,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" } } @@ -41379,7 +42457,7 @@ ] }, { - "id": 1099, + "id": 1146, "name": "isAuthSessionMissingError", "kind": 64, "kindString": "Function", @@ -41393,14 +42471,14 @@ ], "signatures": [ { - "id": 1100, + "id": 1147, "name": "isAuthSessionMissingError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1101, + "id": 1148, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -41417,7 +42495,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" } } @@ -41425,7 +42503,7 @@ ] }, { - "id": 1108, + "id": 1155, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -41439,14 +42517,14 @@ ], "signatures": [ { - "id": 1109, + "id": 1156, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1157, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -41463,7 +42541,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" } } @@ -41471,7 +42549,7 @@ ] }, { - "id": 477, + "id": 498, "name": "navigatorLock", "kind": 64, "kindString": "Function", @@ -41485,7 +42563,7 @@ ], "signatures": [ { - "id": 478, + "id": 499, "name": "navigatorLock", "kind": 4096, "kindString": "Call signature", @@ -41496,7 +42574,7 @@ }, "typeParameter": [ { - "id": 479, + "id": 500, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -41505,7 +42583,7 @@ ], "parameters": [ { - "id": 480, + "id": 501, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -41519,7 +42597,7 @@ } }, { - "id": 481, + "id": 502, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -41533,7 +42611,7 @@ } }, { - "id": 482, + "id": 503, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -41544,14 +42622,14 @@ "type": { "type": "reflection", "declaration": { - "id": 483, + "id": 504, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 484, + "id": 505, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -41561,7 +42639,7 @@ "typeArguments": [ { "type": "reference", - "id": 479, + "id": 500, "name": "R" } ], @@ -41580,7 +42658,7 @@ "typeArguments": [ { "type": "reference", - "id": 479, + "id": 500, "name": "R" } ], @@ -41596,34 +42674,36 @@ { "title": "Classes", "kind": 128, - "children": [1121, 1111, 1178, 1169, 1161, 1205, 1232, 1153, 1131, 1242, 1141, 1, 78, 485] + "children": [ + 1168, 1158, 1225, 1216, 1301, 1208, 1252, 1279, 1200, 1178, 1289, 1188, 1, 78, 506 + ] }, { "title": "Interfaces", "kind": 256, "children": [ - 644, 705, 660, 873, 1021, 972, 635, 718, 675, 668, 699, 648, 672, 811, 803, 819 + 665, 726, 681, 894, 1042, 993, 1133, 656, 739, 696, 689, 720, 669, 693, 832, 824, 840 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 495, 494, 779, 1005, 996, 1018, 1009, 938, 1081, 928, 1065, 961, 949, 929, 915, 559, - 532, 545, 574, 587, 960, 1034, 823, 867, 857, 876, 890, 877, 897, 862, 851, 505, 1031, - 496, 911, 907, 898, 1060, 1055, 899, 902, 822, 602, 1048, 1041, 493, 824, 615, 726, 792, - 780, 749, 762, 838, 1052, 732, 1028, 624, 802, 528, 526 + 516, 515, 800, 1026, 1017, 1039, 1030, 959, 1102, 949, 1086, 982, 970, 950, 936, 580, + 553, 566, 595, 608, 981, 1055, 844, 888, 878, 897, 911, 898, 918, 883, 872, 526, 1052, + 1114, 1129, 517, 932, 928, 919, 1081, 1076, 920, 923, 843, 623, 1069, 1062, 514, 1119, + 845, 636, 747, 813, 801, 770, 783, 859, 1073, 753, 1049, 645, 823, 549, 547 ] }, { "title": "Variables", "kind": 32, - "children": [475, 476, 490] + "children": [496, 497, 511] }, { "title": "Functions", "kind": 64, - "children": [1096, 1093, 1102, 1105, 1099, 1108, 477] + "children": [1143, 1140, 1149, 1152, 1146, 1155, 498] } ], "sources": [ @@ -41643,7 +42723,7 @@ "originalName": "", "children": [ { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -41652,7 +42732,7 @@ }, "children": [ { - "id": 616, + "id": 632, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -41660,27 +42740,27 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 23, + "line": 31, "character": 2 } ], "signatures": [ { - "id": 617, + "id": 633, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 618, + "id": 634, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 619, + "id": 635, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -41697,18 +42777,18 @@ ], "parameters": [ { - "id": 620, + "id": 636, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -41718,7 +42798,7 @@ ], "name": "default", "dereferenced": { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -41730,36 +42810,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -41777,7 +42857,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -41789,7 +42869,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -41798,11 +42878,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -41810,11 +42890,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -41833,16 +42913,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -41852,7 +42932,7 @@ ] }, { - "id": 625, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -41863,7 +42943,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -41873,7 +42953,7 @@ } }, { - "id": 628, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -41883,28 +42963,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 630, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 631, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -41928,7 +43008,7 @@ } }, { - "id": 632, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -41963,7 +43043,7 @@ } }, { - "id": 623, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -41973,7 +43053,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -41995,7 +43075,7 @@ } }, { - "id": 633, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -42005,7 +43085,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -42015,7 +43095,7 @@ } }, { - "id": 621, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -42025,7 +43105,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -42056,7 +43136,7 @@ } }, { - "id": 624, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -42067,7 +43147,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -42077,7 +43157,7 @@ } }, { - "id": 626, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -42087,7 +43167,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -42098,7 +43178,7 @@ "defaultValue": "false" }, { - "id": 627, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -42109,7 +43189,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -42121,7 +43201,7 @@ } }, { - "id": 622, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -42131,7 +43211,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -42143,7 +43223,346 @@ } }, { - "id": 636, + "id": 671, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 672, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 673, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 678, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 674, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 675, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [675] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 676, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 677, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [677] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 668, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 669, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with" + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 670, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -42151,13 +43570,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 637, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -42167,7 +43586,7 @@ }, "parameters": [ { - "id": 638, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -42178,7 +43597,7 @@ } }, { - "id": 639, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -42191,16 +43610,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -42210,7 +43629,7 @@ ] }, { - "id": 640, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -42218,20 +43637,20 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 641, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 642, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -42240,7 +43659,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -42249,11 +43668,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -42261,11 +43680,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -42274,7 +43693,7 @@ } }, { - "id": 643, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -42287,7 +43706,7 @@ ], "parameters": [ { - "id": 644, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -42304,21 +43723,21 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 646, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 647, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -42327,7 +43746,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -42336,11 +43755,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -42348,11 +43767,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -42392,7 +43811,7 @@ } }, { - "id": 648, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -42409,21 +43828,21 @@ { "type": "reflection", "declaration": { - "id": 649, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 650, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -42500,7 +43919,7 @@ } }, { - "id": 634, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -42508,13 +43927,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 635, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -42528,16 +43947,16 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -42545,11 +43964,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -42569,36 +43988,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -42616,7 +44035,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -42628,7 +44047,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -42637,11 +44056,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -42649,11 +44068,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -44045,7 +45464,7 @@ ] }, { - "id": 654, + "id": 681, "name": "PostgrestError", "kind": 128, "kindString": "Class", @@ -44056,7 +45475,7 @@ }, "children": [ { - "id": 655, + "id": 682, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -44070,14 +45489,14 @@ ], "signatures": [ { - "id": 656, + "id": 683, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 657, + "id": 684, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -44085,14 +45504,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 662, + "id": 689, "name": "code", "kind": 1024, "kindString": "Property", @@ -44110,7 +45529,7 @@ } }, { - "id": 660, + "id": 687, "name": "details", "kind": 1024, "kindString": "Property", @@ -44128,7 +45547,7 @@ } }, { - "id": 661, + "id": 688, "name": "hint", "kind": 1024, "kindString": "Property", @@ -44146,7 +45565,7 @@ } }, { - "id": 659, + "id": 686, "name": "message", "kind": 1024, "kindString": "Property", @@ -44168,7 +45587,7 @@ { "title": "Properties", "kind": 1024, - "children": [662, 660, 661, 659] + "children": [689, 687, 688, 686] } ] } @@ -44177,7 +45596,7 @@ ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" }, "overwrites": { @@ -44192,7 +45611,7 @@ } }, { - "id": 665, + "id": 692, "name": "code", "kind": 1024, "kindString": "Property", @@ -44210,7 +45629,7 @@ } }, { - "id": 663, + "id": 690, "name": "details", "kind": 1024, "kindString": "Property", @@ -44228,7 +45647,7 @@ } }, { - "id": 664, + "id": 691, "name": "hint", "kind": 1024, "kindString": "Property", @@ -44250,12 +45669,12 @@ { "title": "Constructors", "kind": 512, - "children": [655] + "children": [682] }, { "title": "Properties", "kind": 1024, - "children": [665, 663, 664] + "children": [692, 690, 691] } ], "sources": [ @@ -44368,7 +45787,7 @@ "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -44382,7 +45801,7 @@ ], "name": "default", "dereferenced": { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -44391,7 +45810,7 @@ }, "children": [ { - "id": 616, + "id": 632, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -44399,27 +45818,27 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 23, + "line": 31, "character": 2 } ], "signatures": [ { - "id": 617, + "id": 633, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 618, + "id": 634, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 619, + "id": 635, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -44436,18 +45855,18 @@ ], "parameters": [ { - "id": 620, + "id": 636, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -44462,16 +45881,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -44481,7 +45900,7 @@ ] }, { - "id": 625, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -44492,7 +45911,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -44502,7 +45921,7 @@ } }, { - "id": 628, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -44512,28 +45931,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 630, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 631, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -44557,7 +45976,7 @@ } }, { - "id": 632, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -44592,7 +46011,7 @@ } }, { - "id": 623, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -44602,7 +46021,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -44624,7 +46043,7 @@ } }, { - "id": 633, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -44634,7 +46053,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -44644,7 +46063,7 @@ } }, { - "id": 621, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -44654,7 +46073,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -44685,7 +46104,7 @@ } }, { - "id": 624, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -44696,7 +46115,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -44706,7 +46125,7 @@ } }, { - "id": 626, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -44716,7 +46135,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -44727,7 +46146,7 @@ "defaultValue": "false" }, { - "id": 627, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -44738,7 +46157,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -44750,7 +46169,7 @@ } }, { - "id": 622, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -44760,7 +46179,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -44772,7 +46191,346 @@ } }, { - "id": 636, + "id": 671, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 672, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 673, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 678, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 674, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 675, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [675] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 676, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 677, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [677] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 668, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 669, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with" + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 670, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -44780,13 +46538,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 637, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -44796,7 +46554,7 @@ }, "parameters": [ { - "id": 638, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -44807,7 +46565,7 @@ } }, { - "id": 639, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -44820,16 +46578,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -44839,7 +46597,7 @@ ] }, { - "id": 640, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -44847,20 +46605,20 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 641, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 642, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -44869,7 +46627,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -44878,11 +46636,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -44890,11 +46648,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -44903,7 +46661,7 @@ } }, { - "id": 643, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -44916,7 +46674,7 @@ ], "parameters": [ { - "id": 644, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -44933,21 +46691,21 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 646, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 647, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -44956,7 +46714,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -44965,11 +46723,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -44977,11 +46735,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -45021,7 +46779,7 @@ } }, { - "id": 648, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -45038,21 +46796,21 @@ { "type": "reflection", "declaration": { - "id": 649, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 650, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -45129,7 +46887,7 @@ } }, { - "id": 634, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -45137,13 +46895,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 635, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -45157,16 +46915,16 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -45174,11 +46932,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -45198,36 +46956,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -45245,7 +47003,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -45257,7 +47015,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -45266,11 +47024,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -45278,11 +47036,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -45333,14 +47091,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 493, + "id": 501, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 492, + "id": 500, "name": "default.constructor" } }, @@ -45356,7 +47114,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -45366,7 +47124,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 583, + "id": 591, "name": "default.body" } }, @@ -45381,7 +47139,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], @@ -45461,7 +47219,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 586, + "id": 594, "name": "default.fetch" } }, @@ -45476,7 +47234,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -45498,7 +47256,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 589, "name": "default.headers" } }, @@ -45513,7 +47271,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -45523,7 +47281,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 591, + "id": 599, "name": "default.isMaybeSingle" } }, @@ -45538,7 +47296,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -45569,7 +47327,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 587, "name": "default.method" } }, @@ -45585,7 +47343,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -45595,7 +47353,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 582, + "id": 590, "name": "default.schema" } }, @@ -45610,7 +47368,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -45621,7 +47379,7 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 584, + "id": 592, "name": "default.shouldThrowOnError" } }, @@ -45637,7 +47395,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -45649,7 +47407,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 585, + "id": 593, "name": "default.signal" } }, @@ -45664,7 +47422,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -45676,7 +47434,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 588, "name": "default.url" } }, @@ -45755,14 +47513,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 552, + "id": 560, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 551, + "id": 559, "name": "default.abortSignal" } }, @@ -46287,7 +48045,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -46302,14 +48060,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 561, + "id": 569, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 560, + "id": 568, "name": "default.csv" } }, @@ -46698,7 +48456,7 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -46713,7 +48471,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "array", @@ -46745,14 +48503,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 565, + "id": 573, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 564, + "id": 572, "name": "default.explain" } }, @@ -47079,7 +48837,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -47106,14 +48864,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 563, + "id": 571, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 562, + "id": 570, "name": "default.geojson" } }, @@ -49168,14 +50926,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 537, + "id": 545, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 536, + "id": 544, "name": "default.limit" } }, @@ -49784,7 +51542,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "union", @@ -49809,14 +51567,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 558, + "id": 566, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 557, + "id": 565, "name": "default.maybeSingle" } }, @@ -50542,7 +52300,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 506, + "id": 514, "name": "default.order" } }, @@ -50706,7 +52464,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 514, + "id": 522, "name": "default.order" } }, @@ -50882,7 +52640,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 521, + "id": 529, "name": "default.order" } }, @@ -51043,14 +52801,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 529, + "id": 537, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 505, + "id": 513, "name": "default.order" } }, @@ -51270,6 +53028,282 @@ } ] }, + { + "id": 486, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 487, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 488, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 493, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 489, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 490, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [490] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 491, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 492, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [492] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 619, + "name": "default.overrideTypes" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 618, + "name": "default.overrideTypes" + } + }, { "id": 419, "name": "range", @@ -51434,14 +53468,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 544, + "id": 552, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 543, + "id": 551, "name": "default.range" } }, @@ -52329,7 +54363,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 311, + "line": 312, "character": 2 } ], @@ -52341,7 +54375,13 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`." + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] }, "typeParameter": [ { @@ -52351,13 +54391,13 @@ "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with\n" + "shortText": "The new result type to override with" } } ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -52371,8 +54411,19 @@ }, { "type": "reference", - "id": 454, - "name": "NewResult" + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 454, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" }, { "type": "reference", @@ -52389,14 +54440,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 585, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 576, + "id": 584, "name": "default.returns" } }, @@ -52458,14 +54509,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 575, + "id": 583, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 574, + "id": 582, "name": "default.rollback" } }, @@ -52517,7 +54568,7 @@ "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", @@ -52571,7 +54622,7 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -52606,14 +54657,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 501, + "id": 509, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 500, + "id": 508, "name": "default.select" } }, @@ -52626,7 +54677,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], @@ -52698,14 +54749,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 595, + "id": 603, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 594, + "id": 602, "name": "default.setHeader" } }, @@ -52767,7 +54818,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -52783,14 +54834,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 555, + "id": 563, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 554, + "id": 562, "name": "default.single" } }, @@ -53158,7 +55209,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], @@ -53178,7 +55229,7 @@ "flags": {}, "default": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", @@ -53241,7 +55292,7 @@ "flags": {}, "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", @@ -53382,14 +55433,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 599, + "id": 607, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 598, + "id": 606, "name": "default.then" } }, @@ -53402,7 +55453,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], @@ -53454,7 +55505,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -53472,14 +55523,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 593, + "id": 601, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 592, + "id": 600, "name": "default.throwOnError" } } @@ -53500,8 +55551,8 @@ "kind": 2048, "children": [ 427, 271, 263, 436, 160, 440, 366, 438, 170, 178, 226, 234, 242, 258, 250, 202, 210, - 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 419, 311, 279, 287, 295, 303, - 452, 450, 376, 470, 430, 327, 474, 468 + 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 486, 419, 311, 279, 287, 295, + 303, 452, 450, 376, 470, 430, 327, 474, 468 ] } ], @@ -53514,7 +55565,7 @@ ], "typeParameter": [ { - "id": 486, + "id": 494, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -53525,7 +55576,7 @@ } }, { - "id": 487, + "id": 495, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -53548,14 +55599,14 @@ } }, { - "id": 488, + "id": 496, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 489, + "id": 497, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -53566,7 +55617,7 @@ } }, { - "id": 490, + "id": 498, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -53580,7 +55631,7 @@ "extendedTypes": [ { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -54678,7 +56729,7 @@ "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", @@ -55636,28 +57687,28 @@ ] }, { - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 492, + "id": 500, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 493, + "id": 501, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 494, + "id": 502, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -55668,7 +57719,7 @@ } }, { - "id": 495, + "id": 503, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -55691,14 +57742,14 @@ } }, { - "id": 496, + "id": 504, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 497, + "id": 505, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -55709,7 +57760,7 @@ } }, { - "id": 498, + "id": 506, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -55722,18 +57773,18 @@ ], "parameters": [ { - "id": 499, + "id": 507, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { @@ -55743,7 +57794,7 @@ ], "name": "default", "dereferenced": { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -55752,7 +57803,7 @@ }, "children": [ { - "id": 616, + "id": 632, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -55760,27 +57811,27 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 23, + "line": 31, "character": 2 } ], "signatures": [ { - "id": 617, + "id": 633, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 618, + "id": 634, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 619, + "id": 635, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -55797,18 +57848,18 @@ ], "parameters": [ { - "id": 620, + "id": 636, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -55823,16 +57874,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -55842,7 +57893,7 @@ ] }, { - "id": 625, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -55853,7 +57904,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -55863,7 +57914,7 @@ } }, { - "id": 628, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -55873,28 +57924,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 630, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 631, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -55918,7 +57969,7 @@ } }, { - "id": 632, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -55953,7 +58004,7 @@ } }, { - "id": 623, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -55963,7 +58014,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -55985,7 +58036,7 @@ } }, { - "id": 633, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -55995,7 +58046,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -56005,7 +58056,7 @@ } }, { - "id": 621, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -56015,7 +58066,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -56046,7 +58097,7 @@ } }, { - "id": 624, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -56057,7 +58108,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -56067,7 +58118,7 @@ } }, { - "id": 626, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -56077,7 +58128,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -56088,7 +58139,7 @@ "defaultValue": "false" }, { - "id": 627, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -56099,7 +58150,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -56111,7 +58162,7 @@ } }, { - "id": 622, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -56121,7 +58172,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -56133,7 +58184,346 @@ } }, { - "id": 636, + "id": 671, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 672, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 673, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 678, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 674, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 675, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [675] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 676, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 677, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [677] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 668, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 669, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with" + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 670, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -56141,13 +58531,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 637, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -56157,7 +58547,7 @@ }, "parameters": [ { - "id": 638, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -56168,7 +58558,7 @@ } }, { - "id": 639, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -56181,16 +58571,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -56200,7 +58590,7 @@ ] }, { - "id": 640, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -56208,20 +58598,20 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 641, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 642, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -56230,7 +58620,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -56239,11 +58629,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -56251,11 +58641,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -56264,7 +58654,7 @@ } }, { - "id": 643, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -56277,7 +58667,7 @@ ], "parameters": [ { - "id": 644, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -56294,21 +58684,21 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 646, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 647, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -56317,7 +58707,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -56326,11 +58716,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -56338,11 +58728,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -56382,7 +58772,7 @@ } }, { - "id": 648, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -56399,21 +58789,21 @@ { "type": "reflection", "declaration": { - "id": 649, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 650, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -56490,7 +58880,7 @@ } }, { - "id": 634, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -56498,13 +58888,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 635, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -56518,16 +58908,16 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -56535,11 +58925,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -56559,36 +58949,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -56606,7 +58996,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -56618,7 +59008,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -56627,11 +59017,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -56639,11 +59029,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -56662,31 +59052,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -56694,19 +59084,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 617, + "id": 633, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 616, + "id": 632, "name": "default.constructor" } }, { - "id": 583, + "id": 591, "name": "body", "kind": 1024, "kindString": "Property", @@ -56717,7 +59107,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -56727,12 +59117,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 625, + "id": 641, "name": "default.body" } }, { - "id": 586, + "id": 594, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -56742,28 +59132,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 587, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 588, + "id": 596, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 589, + "id": 597, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -56787,7 +59177,7 @@ } }, { - "id": 590, + "id": 598, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -56822,12 +59212,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 628, + "id": 644, "name": "default.fetch" } }, { - "id": 581, + "id": 589, "name": "headers", "kind": 1024, "kindString": "Property", @@ -56837,7 +59227,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -56859,12 +59249,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 623, + "id": 639, "name": "default.headers" } }, { - "id": 591, + "id": 599, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -56874,7 +59264,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -56884,12 +59274,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 633, + "id": 649, "name": "default.isMaybeSingle" } }, { - "id": 579, + "id": 587, "name": "method", "kind": 1024, "kindString": "Property", @@ -56899,7 +59289,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -56930,12 +59320,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 621, + "id": 637, "name": "default.method" } }, { - "id": 582, + "id": 590, "name": "schema", "kind": 1024, "kindString": "Property", @@ -56946,7 +59336,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -56956,12 +59346,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 624, + "id": 640, "name": "default.schema" } }, { - "id": 584, + "id": 592, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -56971,7 +59361,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -56982,12 +59372,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 626, + "id": 642, "name": "default.shouldThrowOnError" } }, { - "id": 585, + "id": 593, "name": "signal", "kind": 1024, "kindString": "Property", @@ -56998,7 +59388,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -57010,12 +59400,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 627, + "id": 643, "name": "default.signal" } }, { - "id": 580, + "id": 588, "name": "url", "kind": 1024, "kindString": "Property", @@ -57025,7 +59415,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -57037,12 +59427,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 622, + "id": 638, "name": "default.url" } }, { - "id": 551, + "id": 559, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -57056,7 +59446,7 @@ ], "signatures": [ { - "id": 552, + "id": 560, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -57066,7 +59456,7 @@ }, "parameters": [ { - "id": 553, + "id": 561, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -57084,31 +59474,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -57118,7 +59508,7 @@ ] }, { - "id": 560, + "id": 568, "name": "csv", "kind": 2048, "kindString": "Method", @@ -57132,7 +59522,7 @@ ], "signatures": [ { - "id": 561, + "id": 569, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -57142,7 +59532,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -57159,7 +59549,7 @@ ] }, { - "id": 564, + "id": 572, "name": "explain", "kind": 2048, "kindString": "Method", @@ -57173,7 +59563,7 @@ ], "signatures": [ { - "id": 565, + "id": 573, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -57184,7 +59574,7 @@ }, "parameters": [ { - "id": 566, + "id": 574, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -57196,14 +59586,14 @@ "type": { "type": "reflection", "declaration": { - "id": 567, + "id": 575, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 576, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -57226,7 +59616,7 @@ } }, { - "id": 571, + "id": 579, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -57249,7 +59639,7 @@ } }, { - "id": 573, + "id": 581, "name": "format", "kind": 1024, "kindString": "Property", @@ -57281,7 +59671,7 @@ } }, { - "id": 570, + "id": 578, "name": "settings", "kind": 1024, "kindString": "Property", @@ -57304,7 +59694,7 @@ } }, { - "id": 569, + "id": 577, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -57327,7 +59717,7 @@ } }, { - "id": 572, + "id": 580, "name": "wal", "kind": 1024, "kindString": "Property", @@ -57354,7 +59744,7 @@ { "title": "Properties", "kind": 1024, - "children": [568, 571, 573, 570, 569, 572] + "children": [576, 579, 581, 578, 577, 580] } ] } @@ -57367,7 +59757,7 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -57382,7 +59772,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "array", @@ -57416,7 +59806,7 @@ ] }, { - "id": 562, + "id": 570, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -57430,7 +59820,7 @@ ], "signatures": [ { - "id": 563, + "id": 571, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -57440,7 +59830,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -57469,7 +59859,7 @@ ] }, { - "id": 536, + "id": 544, "name": "limit", "kind": 2048, "kindString": "Method", @@ -57483,7 +59873,7 @@ ], "signatures": [ { - "id": 537, + "id": 545, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -57493,7 +59883,7 @@ }, "parameters": [ { - "id": 538, + "id": 546, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -57506,931 +59896,6 @@ "name": "number" } }, - { - "id": 539, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 9 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 32 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [541, 542] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 557, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 2 - } - ], - "signatures": [ - { - "id": 558, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "typeParameter": [ - { - "id": 559, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 496, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "id": 615, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 435, - "name": "ResultOne" - } - ] - }, - { - "type": "literal", - "value": false - } - ], - "name": "default" - } - } - ] - }, - { - "id": 505, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 506, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" - }, - "typeParameter": [ - { - "id": 507, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 508, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 383, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 509, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 511, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 512, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 513, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a referenced table by\nits columns" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [511, 512, 513] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 514, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" - }, - "parameters": [ - { - "id": 515, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 516, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 517, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 518, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 519, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 520, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a referenced table by\nits columns" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [518, 519, 520] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 521, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" - } - ] - }, - "typeParameter": [ - { - "id": 522, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 523, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 398, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 524, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 528, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 527, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [526, 528, 527] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 529, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" - } - ] - }, - "parameters": [ - { - "id": 530, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 531, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 533, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 535, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [533, 535, 534] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 543, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 158, - "character": 2 - } - ], - "signatures": [ - { - "id": 544, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." - }, - "parameters": [ - { - "id": 545, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 546, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, { "id": 547, "name": "options", @@ -58464,7 +59929,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 164, + "line": 136, "character": 9 } ], @@ -58484,6 +59949,1207 @@ "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 136, + "character": 32 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [549, 550] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 565, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 204, + "character": 2 + } + ], + "signatures": [ + { + "id": 566, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + }, + "typeParameter": [ + { + "id": 567, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 504, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 435, + "name": "ResultOne" + } + ] + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + } + } + ] + }, + { + "id": 513, + "name": "order", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 514, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + }, + "typeParameter": [ + { + "id": 515, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 516, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 517, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 518, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 519, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 520, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 521, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a referenced table by\nits columns" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [519, 520, 521] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 522, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + }, + "parameters": [ + { + "id": 523, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 524, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 525, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 526, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 527, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 528, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a referenced table by\nits columns" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [526, 527, 528] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 529, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", + "tags": [ + { + "tag": "deprecated", + "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + } + ] + }, + "typeParameter": [ + { + "id": 530, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 531, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 398, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 532, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 533, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 534, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 536, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + }, + { + "id": 535, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [534, 536, 535] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 537, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", + "tags": [ + { + "tag": "deprecated", + "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + } + ] + }, + "parameters": [ + { + "id": 538, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 539, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 540, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 541, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 543, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 542, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [541, 543, 542] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 618, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 619, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 620, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 625, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 621, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 622, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [622] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 623, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 624, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [624] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 672, + "name": "default.overrideTypes" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 671, + "name": "default.overrideTypes" + } + }, + { + "id": 551, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 158, + "character": 2 + } + ], + "signatures": [ + { + "id": 552, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + }, + "parameters": [ + { + "id": 553, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 554, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 555, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 556, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 557, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 164, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 558, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", @@ -58501,7 +61167,7 @@ { "title": "Properties", "kind": 1024, - "children": [549, 550] + "children": [557, 558] } ] } @@ -58511,31 +61177,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -58545,7 +61211,7 @@ ] }, { - "id": 576, + "id": 584, "name": "returns", "kind": 2048, "kindString": "Method", @@ -58553,69 +61219,96 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 311, + "line": 312, "character": 2 } ], "signatures": [ { - "id": 577, + "id": 585, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`." + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] }, "typeParameter": [ { - "id": 578, + "id": 586, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with\n" + "shortText": "The new result type to override with" } } ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 454, - "name": "NewResult" + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 454, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], "name": "default" + }, + "overwrites": { + "type": "reference", + "id": 669, + "name": "default.returns" } } - ] + ], + "overwrites": { + "type": "reference", + "id": 668, + "name": "default.returns" + } }, { - "id": 574, + "id": 582, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -58629,7 +61322,7 @@ ], "signatures": [ { - "id": 575, + "id": 583, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -58640,31 +61333,31 @@ }, "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -58674,7 +61367,7 @@ ] }, { - "id": 500, + "id": 508, "name": "select", "kind": 2048, "kindString": "Method", @@ -58688,7 +61381,7 @@ ], "signatures": [ { - "id": 501, + "id": 509, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -58699,7 +61392,7 @@ }, "typeParameter": [ { - "id": 502, + "id": 510, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -58714,33 +61407,33 @@ } }, { - "id": 503, + "id": 511, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" }, { @@ -58755,7 +61448,7 @@ ], "parameters": [ { - "id": 504, + "id": 512, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -58775,16 +61468,16 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { @@ -58797,12 +61490,12 @@ }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -58812,7 +61505,7 @@ ] }, { - "id": 594, + "id": 602, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -58820,13 +61513,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 595, + "id": 603, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -58836,7 +61529,7 @@ }, "parameters": [ { - "id": 596, + "id": 604, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -58847,7 +61540,7 @@ } }, { - "id": 597, + "id": 605, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -58860,31 +61553,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -58892,19 +61585,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 637, + "id": 653, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 636, + "id": 652, "name": "default.setHeader" } }, { - "id": 554, + "id": 562, "name": "single", "kind": 2048, "kindString": "Method", @@ -58918,7 +61611,7 @@ ], "signatures": [ { - "id": 555, + "id": 563, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -58929,7 +61622,7 @@ }, "typeParameter": [ { - "id": 556, + "id": 564, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -58938,7 +61631,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, "extendsType": { @@ -58961,7 +61654,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -58979,7 +61672,7 @@ ] }, { - "id": 598, + "id": 606, "name": "then", "kind": 2048, "kindString": "Method", @@ -58987,31 +61680,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 599, + "id": 607, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 600, + "id": 608, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -59019,7 +61712,7 @@ } }, { - "id": 601, + "id": 609, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -59032,7 +61725,7 @@ ], "parameters": [ { - "id": 602, + "id": 610, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -59049,32 +61742,32 @@ { "type": "reflection", "declaration": { - "id": 603, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 604, + "id": 612, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 605, + "id": 613, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -59113,7 +61806,7 @@ } }, { - "id": 606, + "id": 614, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -59130,21 +61823,21 @@ { "type": "reflection", "declaration": { - "id": 607, + "id": 615, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 608, + "id": 616, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 609, + "id": 617, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -59211,19 +61904,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 641, + "id": 657, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 640, + "id": 656, "name": "default.then" } }, { - "id": 592, + "id": 600, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -59231,13 +61924,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 593, + "id": 601, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -59251,31 +61944,31 @@ "types": [ { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -59283,11 +61976,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { @@ -59301,14 +61994,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 635, + "id": 651, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 634, + "id": 650, "name": "default.throwOnError" } } @@ -59317,18 +62010,18 @@ { "title": "Constructors", "kind": 512, - "children": [492] + "children": [500] }, { "title": "Properties", "kind": 1024, - "children": [583, 586, 581, 591, 579, 582, 584, 585, 580] + "children": [591, 594, 589, 599, 587, 590, 592, 593, 588] }, { "title": "Methods", "kind": 2048, "children": [ - 551, 560, 564, 562, 536, 557, 505, 543, 576, 574, 500, 594, 554, 598, 592 + 559, 568, 572, 570, 544, 565, 513, 618, 551, 584, 582, 508, 602, 562, 606, 600 ] } ], @@ -59341,7 +62034,7 @@ ], "typeParameter": [ { - "id": 610, + "id": 626, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -59352,7 +62045,7 @@ } }, { - "id": 611, + "id": 627, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -59375,14 +62068,14 @@ } }, { - "id": 612, + "id": 628, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 613, + "id": 629, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -59393,7 +62086,7 @@ } }, { - "id": 614, + "id": 630, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -59407,11 +62100,11 @@ "extendedTypes": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -59427,18 +62120,54 @@ ] }, { - "id": 668, + "id": 695, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 671, + "id": 698, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 697, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 696, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -59446,48 +62175,12 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 669, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 20, - "character": 2 - } - ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default", "dereferenced": { - "id": 654, + "id": 681, "name": "PostgrestError", "kind": 128, "kindString": "Class", @@ -59498,7 +62191,7 @@ }, "children": [ { - "id": 655, + "id": 682, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -59512,14 +62205,14 @@ ], "signatures": [ { - "id": 656, + "id": 683, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 657, + "id": 684, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -59527,14 +62220,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 662, + "id": 689, "name": "code", "kind": 1024, "kindString": "Property", @@ -59552,7 +62245,7 @@ } }, { - "id": 660, + "id": 687, "name": "details", "kind": 1024, "kindString": "Property", @@ -59570,7 +62263,7 @@ } }, { - "id": 661, + "id": 688, "name": "hint", "kind": 1024, "kindString": "Property", @@ -59588,7 +62281,7 @@ } }, { - "id": 659, + "id": 686, "name": "message", "kind": 1024, "kindString": "Property", @@ -59610,7 +62303,7 @@ { "title": "Properties", "kind": 1024, - "children": [662, 660, 661, 659] + "children": [689, 687, 688, 686] } ] } @@ -59619,7 +62312,7 @@ ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" }, "overwrites": { @@ -59634,7 +62327,7 @@ } }, { - "id": 665, + "id": 692, "name": "code", "kind": 1024, "kindString": "Property", @@ -59652,7 +62345,7 @@ } }, { - "id": 663, + "id": 690, "name": "details", "kind": 1024, "kindString": "Property", @@ -59670,7 +62363,7 @@ } }, { - "id": 664, + "id": 691, "name": "hint", "kind": 1024, "kindString": "Property", @@ -59692,12 +62385,12 @@ { "title": "Constructors", "kind": 512, - "children": [655] + "children": [682] }, { "title": "Properties", "kind": 1024, - "children": [665, 663, 664] + "children": [692, 690, 691] } ], "sources": [ @@ -59719,7 +62412,7 @@ } }, { - "id": 672, + "id": 699, "name": "status", "kind": 1024, "kindString": "Property", @@ -59727,7 +62420,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -59741,7 +62434,7 @@ } }, { - "id": 673, + "id": 700, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -59749,7 +62442,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -59767,13 +62460,13 @@ { "title": "Properties", "kind": 1024, - "children": [671, 670, 669, 672, 673] + "children": [698, 697, 696, 699, 700] } ], "sources": [ { "fileName": "src/types.ts", - "line": 19, + "line": 21, "character": 17 } ], @@ -59785,14 +62478,14 @@ ] }, { - "id": 674, + "id": 701, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 677, + "id": 704, "name": "count", "kind": 1024, "kindString": "Property", @@ -59800,7 +62493,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 17, + "line": 19, "character": 2 } ], @@ -59819,7 +62512,7 @@ } }, { - "id": 676, + "id": 703, "name": "data", "kind": 1024, "kindString": "Property", @@ -59827,19 +62520,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 16, + "line": 18, "character": 2 } ], "type": { "type": "reference", - "id": 680, + "id": 707, "name": "T", "dereferenced": {} } }, { - "id": 675, + "id": 702, "name": "error", "kind": 1024, "kindString": "Property", @@ -59847,7 +62540,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 15, + "line": 17, "character": 2 } ], @@ -59857,7 +62550,7 @@ } }, { - "id": 678, + "id": 705, "name": "status", "kind": 1024, "kindString": "Property", @@ -59865,7 +62558,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -59879,7 +62572,7 @@ } }, { - "id": 679, + "id": 706, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -59887,7 +62580,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -59905,19 +62598,19 @@ { "title": "Properties", "kind": 1024, - "children": [677, 676, 675, 678, 679] + "children": [704, 703, 702, 705, 706] } ], "sources": [ { "fileName": "src/types.ts", - "line": 14, + "line": 16, "character": 17 } ], "typeParameter": [ { - "id": 680, + "id": 707, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -59932,7 +62625,7 @@ ] }, { - "id": 683, + "id": 710, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -59940,13 +62633,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 31, "character": 12 } ], "typeParameter": [ { - "id": 684, + "id": 711, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -59955,14 +62648,14 @@ ], "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 684, + "id": 711, "name": "T" }, { @@ -59976,11 +62669,49 @@ } }, { - "id": 666, + "id": 693, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 32, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 694, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 708, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "id": 694, + "name": "T" + } + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 708, + "name": "PostgrestSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -59990,45 +62721,7 @@ ], "typeParameter": [ { - "id": 667, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reference", - "id": 681, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 667, - "name": "T" - } - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 681, - "name": "PostgrestSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 28, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 682, + "id": 709, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -60039,14 +62732,14 @@ "type": "union", "types": [ { - "id": 674, + "id": 701, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 677, + "id": 704, "name": "count", "kind": 1024, "kindString": "Property", @@ -60054,7 +62747,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 17, + "line": 19, "character": 2 } ], @@ -60073,7 +62766,7 @@ } }, { - "id": 676, + "id": 703, "name": "data", "kind": 1024, "kindString": "Property", @@ -60081,19 +62774,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 16, + "line": 18, "character": 2 } ], "type": { "type": "reference", - "id": 680, + "id": 707, "name": "T", "dereferenced": {} } }, { - "id": 675, + "id": 702, "name": "error", "kind": 1024, "kindString": "Property", @@ -60101,7 +62794,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 15, + "line": 17, "character": 2 } ], @@ -60111,7 +62804,7 @@ } }, { - "id": 678, + "id": 705, "name": "status", "kind": 1024, "kindString": "Property", @@ -60119,7 +62812,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -60133,7 +62826,7 @@ } }, { - "id": 679, + "id": 706, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -60141,7 +62834,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -60159,19 +62852,19 @@ { "title": "Properties", "kind": 1024, - "children": [677, 676, 675, 678, 679] + "children": [704, 703, 702, 705, 706] } ], "sources": [ { "fileName": "src/types.ts", - "line": 14, + "line": 16, "character": 17 } ], "typeParameter": [ { - "id": 680, + "id": 707, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -60186,18 +62879,54 @@ ] }, { - "id": 668, + "id": 695, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 671, + "id": 698, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 697, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 696, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -60205,48 +62934,12 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 669, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 20, - "character": 2 - } - ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default", "dereferenced": { - "id": 654, + "id": 681, "name": "PostgrestError", "kind": 128, "kindString": "Class", @@ -60257,7 +62950,7 @@ }, "children": [ { - "id": 655, + "id": 682, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -60271,14 +62964,14 @@ ], "signatures": [ { - "id": 656, + "id": 683, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 657, + "id": 684, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -60286,14 +62979,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 662, + "id": 689, "name": "code", "kind": 1024, "kindString": "Property", @@ -60311,7 +63004,7 @@ } }, { - "id": 660, + "id": 687, "name": "details", "kind": 1024, "kindString": "Property", @@ -60329,7 +63022,7 @@ } }, { - "id": 661, + "id": 688, "name": "hint", "kind": 1024, "kindString": "Property", @@ -60347,7 +63040,7 @@ } }, { - "id": 659, + "id": 686, "name": "message", "kind": 1024, "kindString": "Property", @@ -60369,7 +63062,7 @@ { "title": "Properties", "kind": 1024, - "children": [662, 660, 661, 659] + "children": [689, 687, 688, 686] } ] } @@ -60378,7 +63071,7 @@ ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" }, "overwrites": { @@ -60393,7 +63086,7 @@ } }, { - "id": 665, + "id": 692, "name": "code", "kind": 1024, "kindString": "Property", @@ -60411,7 +63104,7 @@ } }, { - "id": 663, + "id": 690, "name": "details", "kind": 1024, "kindString": "Property", @@ -60429,7 +63122,7 @@ } }, { - "id": 664, + "id": 691, "name": "hint", "kind": 1024, "kindString": "Property", @@ -60451,12 +63144,12 @@ { "title": "Constructors", "kind": 512, - "children": [655] + "children": [682] }, { "title": "Properties", "kind": 1024, - "children": [665, 663, 664] + "children": [692, 690, 691] } ], "sources": [ @@ -60478,7 +63171,7 @@ } }, { - "id": 672, + "id": 699, "name": "status", "kind": 1024, "kindString": "Property", @@ -60486,7 +63179,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -60500,7 +63193,7 @@ } }, { - "id": 673, + "id": 700, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -60508,7 +63201,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -60526,13 +63219,13 @@ { "title": "Properties", "kind": 1024, - "children": [671, 670, 669, 672, 673] + "children": [698, 697, 696, 699, 700] } ], "sources": [ { "fileName": "src/types.ts", - "line": 19, + "line": 21, "character": 17 } ], @@ -60547,7 +63240,7 @@ } }, { - "id": 685, + "id": 712, "name": "UnstableGetResult", "kind": 4194304, "kindString": "Type alias", @@ -60564,7 +63257,7 @@ ], "typeParameter": [ { - "id": 686, + "id": 713, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -60578,7 +63271,7 @@ } }, { - "id": 687, + "id": 714, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -60604,7 +63297,7 @@ } }, { - "id": 688, + "id": 715, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -60614,7 +63307,7 @@ } }, { - "id": 689, + "id": 716, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -60624,7 +63317,7 @@ } }, { - "id": 690, + "id": 717, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -60645,7 +63338,7 @@ "typeArguments": [ { "type": "reference", - "id": 686, + "id": 713, "name": "Schema" } ], @@ -60662,7 +63355,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -60689,7 +63382,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -60725,7 +63418,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, "extendsType": { @@ -60739,7 +63432,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -60773,7 +63466,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -60782,7 +63475,7 @@ }, "trueType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "falseType": { @@ -60792,7 +63485,7 @@ }, { "type": "reference", - "id": 687, + "id": 714, "name": "Row" } ], @@ -60805,7 +63498,7 @@ }, "falseType": { "type": "reference", - "id": 687, + "id": 714, "name": "Row" } }, @@ -60816,7 +63509,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -60843,7 +63536,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -60854,7 +63547,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, "extendsType": { @@ -60869,22 +63562,22 @@ "typeArguments": [ { "type": "reference", - "id": 686, + "id": 713, "name": "Schema" }, { "type": "reference", - "id": 687, + "id": 714, "name": "Row" }, { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, { @@ -60961,7 +63654,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 615, + "id": 631, "name": "default" } } @@ -60991,7 +63684,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 654, + "id": 681, "name": "default" } } @@ -61036,7 +63729,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 491, + "id": 499, "name": "default" } } @@ -61057,17 +63750,17 @@ { "title": "Classes", "kind": 128, - "children": [615, 9, 654, 151, 64, 491] + "children": [631, 9, 681, 151, 64, 499] }, { "title": "Interfaces", "kind": 256, - "children": [668, 674] + "children": [695, 701] }, { "title": "Type Aliases", "kind": 4194304, - "children": [683, 666, 681, 685] + "children": [710, 693, 708, 712] }, { "title": "Variables", diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json index d051fcba473..244a09986b3 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 1121, + "id": 1168, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1122, + "id": 1169, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -28,14 +28,14 @@ ], "signatures": [ { - "id": 1123, + "id": 1170, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1124, + "id": 1171, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 1125, + "id": 1172, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -57,7 +57,7 @@ } }, { - "id": 1126, + "id": 1173, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -79,918 +79,22 @@ ], "type": { "type": "reference", - "id": 1121, + "id": 1168, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, - { - "id": 1128, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1129, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1117, - "name": "AuthError.code" - } - }, - { - "id": 1127, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "id": 1119, - "name": "AuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1122] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1128, 1127] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 30, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1111, - "name": "AuthError" - } - ] - }, - { - "id": 1111, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1112, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 18, - "character": 2 - } - ], - "signatures": [ - { - "id": 1113, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1114, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1115, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1116, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1111, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 1117, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 1119, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1112] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1117, 1119] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 1121, - "name": "AuthApiError" - }, - { - "type": "reference", - "id": 1131, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 1141, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1178, - "name": "AuthImplicitGrantRedirectError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1179, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 2 - } - ], - "signatures": [ - { - "id": 1180, - "name": "new AuthImplicitGrantRedirectError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1181, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1185, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1184, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1185, 1184] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 1178, - "name": "AuthImplicitGrantRedirectError" - }, - "overwrites": { - "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1202, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1203, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1150, - "name": "CustomAuthError.code" - } - }, - { - "id": 1186, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1189, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1188, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1189, 1188] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1200, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1148, - "name": "CustomAuthError.name" - } - }, - { - "id": 1201, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1149, - "name": "CustomAuthError.status" - } - }, - { - "id": 1190, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 2 - } - ], - "signatures": [ - { - "id": 1191, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1196, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1197, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1199, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1198, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1199, 1198] - } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 1194, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 98, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1193, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1195, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1196, 1194, 1193, 1195] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1179] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1202, 1186, 1200, 1201] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1190] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 88, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1141, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1169, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1170, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 83, - "character": 2 - } - ], - "signatures": [ - { - "id": 1171, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1172, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1169, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" - } - }, { "id": 1175, "name": "code", @@ -1014,10 +118,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -1036,36 +136,17 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, - "name": "CustomAuthError.code" - } - }, - { - "id": 1173, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1148, - "name": "CustomAuthError.name" + "id": 1164, + "name": "AuthError.code" } }, { @@ -1080,7 +161,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 57, + "line": 31, "character": 2 } ], @@ -1088,10 +169,10 @@ "type": "intrinsic", "name": "number" }, - "inheritedFrom": { + "overwrites": { "type": "reference", - "id": 1149, - "name": "CustomAuthError.status" + "id": 1166, + "name": "AuthError.status" } } ], @@ -1099,38 +180,38 @@ { "title": "Constructors", "kind": 512, - "children": [1170] + "children": [1169] }, { "title": "Properties", "kind": 1024, - "children": [1175, 1173, 1174] + "children": [1175, 1174] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 82, + "line": 30, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1141, - "name": "CustomAuthError" + "id": 1158, + "name": "AuthError" } ] }, { - "id": 1161, - "name": "AuthInvalidTokenResponseError", + "id": 1158, + "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1162, + "id": 1159, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1138,37 +219,74 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 77, + "line": 18, "character": 2 } ], "signatures": [ { - "id": 1163, - "name": "new AuthInvalidTokenResponseError", + "id": 1160, + "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, + "parameters": [ + { + "id": 1161, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1162, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1163, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "type": { "type": "reference", - "id": 1161, - "name": "AuthInvalidTokenResponseError" + "id": 1158, + "name": "AuthError" }, "overwrites": { "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" + "name": "Error.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" + "name": "Error.constructor" } }, { - "id": 1166, + "id": 1164, "name": "code", "kind": 1024, "kindString": "Property", @@ -1190,9 +308,260 @@ "type": "intrinsic", "name": "undefined" }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1165, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, { "type": "reference", "name": "ErrorCode" + } + ] + } + }, + { + "id": 1166, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1159] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1164, 1166] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 1168, + "name": "AuthApiError" + }, + { + "type": "reference", + "id": 1178, + "name": "AuthUnknownError" + }, + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1225, + "name": "AuthImplicitGrantRedirectError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1226, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 2 + } + ], + "signatures": [ + { + "id": 1227, + "name": "new AuthImplicitGrantRedirectError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1228, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1229, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1230, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1232, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1231, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1232, 1231] + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 1225, + "name": "AuthImplicitGrantRedirectError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1249, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" }, { "type": "intersection", @@ -1204,7 +573,7 @@ { "type": "reflection", "declaration": { - "id": 1167, + "id": 1250, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1212,17 +581,100 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1164, + "id": 1233, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1234, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1236, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1235, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1236, 1235] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 1247, "name": "name", "kind": 1024, "kindString": "Property", @@ -1240,12 +692,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1165, + "id": 1248, "name": "status", "kind": 1024, "kindString": "Property", @@ -1266,7 +718,379 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, + "name": "CustomAuthError.status" + } + }, + { + "id": 1237, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 95, + "character": 2 + } + ], + "signatures": [ + { + "id": 1238, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1239, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1243, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 100, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1244, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1246, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1245, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1246, 1245] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 1241, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 98, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1240, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 97, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1242, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 99, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1243, 1241, 1240, 1242] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1226] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1249, 1233, 1247, 1248] + }, + { + "title": "Methods", + "kind": 2048, + "children": [1237] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 88, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1216, + "name": "AuthInvalidCredentialsError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1217, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 83, + "character": 2 + } + ], + "signatures": [ + { + "id": 1218, + "name": "new AuthInvalidCredentialsError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1219, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1216, + "name": "AuthInvalidCredentialsError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1222, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1223, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1220, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1221, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, "name": "CustomAuthError.status" } } @@ -1275,12 +1099,377 @@ { "title": "Constructors", "kind": 512, - "children": [1162] + "children": [1217] }, { "title": "Properties", "kind": 1024, - "children": [1166, 1164, 1165] + "children": [1222, 1220, 1221] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 82, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1301, + "name": "AuthInvalidJwtError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1302, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 162, + "character": 2 + } + ], + "signatures": [ + { + "id": 1303, + "name": "new AuthInvalidJwtError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1304, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1301, + "name": "AuthInvalidJwtError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1307, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1308, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1305, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1306, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1302] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1307, 1305, 1306] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 161, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1208, + "name": "AuthInvalidTokenResponseError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1209, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 2 + } + ], + "signatures": [ + { + "id": 1210, + "name": "new AuthInvalidTokenResponseError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 1208, + "name": "AuthInvalidTokenResponseError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1213, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1214, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1211, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1212, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1209] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1213, 1211, 1212] } ], "sources": [ @@ -1293,20 +1482,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1206, + "id": 1253, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1320,14 +1509,14 @@ ], "signatures": [ { - "id": 1207, + "id": 1254, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1208, + "id": 1255, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1338,7 +1527,7 @@ } }, { - "id": 1209, + "id": 1256, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -1353,14 +1542,14 @@ { "type": "reflection", "declaration": { - "id": 1210, + "id": 1257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1212, + "id": 1259, "name": "code", "kind": 1024, "kindString": "Property", @@ -1378,7 +1567,7 @@ } }, { - "id": 1211, + "id": 1258, "name": "error", "kind": 1024, "kindString": "Property", @@ -1400,7 +1589,7 @@ { "title": "Properties", "kind": 1024, - "children": [1212, 1211] + "children": [1259, 1258] } ] } @@ -1412,24 +1601,24 @@ ], "type": { "type": "reference", - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1229, + "id": 1276, "name": "code", "kind": 1024, "kindString": "Property", @@ -1451,10 +1640,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -1465,7 +1650,7 @@ { "type": "reflection", "declaration": { - "id": 1230, + "id": 1277, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1473,17 +1658,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1213, + "id": 1260, "name": "details", "kind": 1024, "kindString": "Property", @@ -1505,14 +1694,14 @@ { "type": "reflection", "declaration": { - "id": 1214, + "id": 1261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1216, + "id": 1263, "name": "code", "kind": 1024, "kindString": "Property", @@ -1530,7 +1719,7 @@ } }, { - "id": 1215, + "id": 1262, "name": "error", "kind": 1024, "kindString": "Property", @@ -1552,7 +1741,7 @@ { "title": "Properties", "kind": 1024, - "children": [1216, 1215] + "children": [1263, 1262] } ] } @@ -1562,7 +1751,7 @@ "defaultValue": "null" }, { - "id": 1227, + "id": 1274, "name": "name", "kind": 1024, "kindString": "Property", @@ -1580,12 +1769,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1228, + "id": 1275, "name": "status", "kind": 1024, "kindString": "Property", @@ -1606,12 +1795,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } }, { - "id": 1217, + "id": 1264, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1625,7 +1814,7 @@ ], "signatures": [ { - "id": 1218, + "id": 1265, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1633,14 +1822,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1219, + "id": 1266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1223, + "id": 1270, "name": "details", "kind": 1024, "kindString": "Property", @@ -1662,14 +1851,14 @@ { "type": "reflection", "declaration": { - "id": 1224, + "id": 1271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1226, + "id": 1273, "name": "code", "kind": 1024, "kindString": "Property", @@ -1687,7 +1876,7 @@ } }, { - "id": 1225, + "id": 1272, "name": "error", "kind": 1024, "kindString": "Property", @@ -1709,7 +1898,7 @@ { "title": "Properties", "kind": 1024, - "children": [1226, 1225] + "children": [1273, 1272] } ] } @@ -1719,7 +1908,7 @@ "defaultValue": "..." }, { - "id": 1221, + "id": 1268, "name": "message", "kind": 1024, "kindString": "Property", @@ -1738,7 +1927,7 @@ "defaultValue": "..." }, { - "id": 1220, + "id": 1267, "name": "name", "kind": 1024, "kindString": "Property", @@ -1757,7 +1946,7 @@ "defaultValue": "..." }, { - "id": 1222, + "id": 1269, "name": "status", "kind": 1024, "kindString": "Property", @@ -1780,7 +1969,7 @@ { "title": "Properties", "kind": 1024, - "children": [1223, 1221, 1220, 1222] + "children": [1270, 1268, 1267, 1269] } ] } @@ -1793,17 +1982,17 @@ { "title": "Constructors", "kind": 512, - "children": [1206] + "children": [1253] }, { "title": "Properties", "kind": 1024, - "children": [1229, 1213, 1227, 1228] + "children": [1276, 1260, 1274, 1275] }, { "title": "Methods", "kind": 2048, - "children": [1217] + "children": [1264] } ], "sources": [ @@ -1816,20 +2005,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1233, + "id": 1280, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1843,14 +2032,14 @@ ], "signatures": [ { - "id": 1234, + "id": 1281, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1235, + "id": 1282, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1861,7 +2050,7 @@ } }, { - "id": 1236, + "id": 1283, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1874,24 +2063,24 @@ ], "type": { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1239, + "id": 1286, "name": "code", "kind": 1024, "kindString": "Property", @@ -1913,10 +2102,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -1927,7 +2112,7 @@ { "type": "reflection", "declaration": { - "id": 1240, + "id": 1287, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1935,17 +2120,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1237, + "id": 1284, "name": "name", "kind": 1024, "kindString": "Property", @@ -1963,12 +2152,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1238, + "id": 1285, "name": "status", "kind": 1024, "kindString": "Property", @@ -1989,7 +2178,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -1998,12 +2187,12 @@ { "title": "Constructors", "kind": 512, - "children": [1233] + "children": [1280] }, { "title": "Properties", "kind": 1024, - "children": [1239, 1237, 1238] + "children": [1286, 1284, 1285] } ], "sources": [ @@ -2016,20 +2205,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1154, + "id": 1201, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2043,31 +2232,31 @@ ], "signatures": [ { - "id": 1155, + "id": 1202, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1158, + "id": 1205, "name": "code", "kind": 1024, "kindString": "Property", @@ -2089,10 +2278,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2103,7 +2288,7 @@ { "type": "reflection", "declaration": { - "id": 1159, + "id": 1206, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2111,17 +2296,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1156, + "id": 1203, "name": "name", "kind": 1024, "kindString": "Property", @@ -2139,12 +2328,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1157, + "id": 1204, "name": "status", "kind": 1024, "kindString": "Property", @@ -2165,7 +2354,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -2174,12 +2363,12 @@ { "title": "Constructors", "kind": 512, - "children": [1154] + "children": [1201] }, { "title": "Properties", "kind": 1024, - "children": [1158, 1156, 1157] + "children": [1205, 1203, 1204] } ], "sources": [ @@ -2192,20 +2381,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1131, + "id": 1178, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1132, + "id": 1179, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2219,14 +2408,14 @@ ], "signatures": [ { - "id": 1133, + "id": 1180, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1134, + "id": 1181, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2237,7 +2426,7 @@ } }, { - "id": 1135, + "id": 1182, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2250,24 +2439,24 @@ ], "type": { "type": "reference", - "id": 1131, + "id": 1178, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, { - "id": 1137, + "id": 1184, "name": "code", "kind": 1024, "kindString": "Property", @@ -2289,10 +2478,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2303,7 +2488,7 @@ { "type": "reflection", "declaration": { - "id": 1138, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2311,17 +2496,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1117, + "id": 1164, "name": "AuthError.code" } }, { - "id": 1136, + "id": 1183, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2339,7 +2528,7 @@ } }, { - "id": 1139, + "id": 1186, "name": "status", "kind": 1024, "kindString": "Property", @@ -2369,7 +2558,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1119, + "id": 1166, "name": "AuthError.status" } } @@ -2378,12 +2567,12 @@ { "title": "Constructors", "kind": 512, - "children": [1132] + "children": [1179] }, { "title": "Properties", "kind": 1024, - "children": [1137, 1136, 1139] + "children": [1184, 1183, 1186] } ], "sources": [ @@ -2396,13 +2585,13 @@ "extendedTypes": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] }, { - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", @@ -2412,7 +2601,7 @@ }, "children": [ { - "id": 1243, + "id": 1290, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2426,14 +2615,14 @@ ], "signatures": [ { - "id": 1244, + "id": 1291, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1245, + "id": 1292, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2444,7 +2633,7 @@ } }, { - "id": 1246, + "id": 1293, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2455,7 +2644,7 @@ } }, { - "id": 1247, + "id": 1294, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -2471,24 +2660,24 @@ ], "type": { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1251, + "id": 1298, "name": "code", "kind": 1024, "kindString": "Property", @@ -2510,10 +2699,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2524,7 +2709,7 @@ { "type": "reflection", "declaration": { - "id": 1252, + "id": 1299, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2532,17 +2717,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1249, + "id": 1296, "name": "name", "kind": 1024, "kindString": "Property", @@ -2560,12 +2749,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1248, + "id": 1295, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -2584,13 +2773,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 526, + "id": 547, "name": "WeakPasswordReasons" } } }, { - "id": 1250, + "id": 1297, "name": "status", "kind": 1024, "kindString": "Property", @@ -2611,7 +2800,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -2620,12 +2809,12 @@ { "title": "Constructors", "kind": 512, - "children": [1243] + "children": [1290] }, { "title": "Properties", "kind": 1024, - "children": [1251, 1249, 1248, 1250] + "children": [1298, 1296, 1295, 1297] } ], "sources": [ @@ -2638,20 +2827,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1141, + "id": 1188, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1142, + "id": 1189, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2665,14 +2854,14 @@ ], "signatures": [ { - "id": 1143, + "id": 1190, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1144, + "id": 1191, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2683,7 +2872,7 @@ } }, { - "id": 1145, + "id": 1192, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2694,7 +2883,7 @@ } }, { - "id": 1146, + "id": 1193, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2705,7 +2894,7 @@ } }, { - "id": 1147, + "id": 1194, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -2727,24 +2916,24 @@ ], "type": { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, { - "id": 1150, + "id": 1197, "name": "code", "kind": 1024, "kindString": "Property", @@ -2766,10 +2955,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2780,7 +2965,7 @@ { "type": "reflection", "declaration": { - "id": 1151, + "id": 1198, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2788,17 +2973,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1117, + "id": 1164, "name": "AuthError.code" } }, { - "id": 1148, + "id": 1195, "name": "name", "kind": 1024, "kindString": "Property", @@ -2820,7 +3009,7 @@ } }, { - "id": 1149, + "id": 1196, "name": "status", "kind": 1024, "kindString": "Property", @@ -2841,7 +3030,7 @@ }, "overwrites": { "type": "reference", - "id": 1119, + "id": 1166, "name": "AuthError.status" } } @@ -2850,12 +3039,12 @@ { "title": "Constructors", "kind": 512, - "children": [1142] + "children": [1189] }, { "title": "Properties", "kind": 1024, - "children": [1150, 1148, 1149] + "children": [1197, 1195, 1196] } ], "sources": [ @@ -2868,45 +3057,50 @@ "extendedTypes": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1161, + "id": 1208, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1169, + "id": 1216, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1178, + "id": 1225, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" + }, + { + "type": "reference", + "id": 1301, + "name": "AuthInvalidJwtError" } ] }, @@ -3148,7 +3342,7 @@ ], "type": { "type": "reference", - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi" } }, @@ -3184,7 +3378,7 @@ "flags": {}, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes" } } @@ -3194,7 +3388,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -3264,7 +3458,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -3307,7 +3501,7 @@ "flags": {}, "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkParams" } } @@ -3317,7 +3511,7 @@ "typeArguments": [ { "type": "reference", - "id": 877, + "id": 898, "name": "GenerateLinkResponse" } ], @@ -3372,7 +3566,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -3503,7 +3697,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -3552,7 +3746,7 @@ }, "type": { "type": "reference", - "id": 1048, + "id": 1069, "name": "PageParams" } } @@ -3632,7 +3826,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -3649,7 +3843,7 @@ }, { "type": "reference", - "id": 1041, + "id": 1062, "name": "Pagination" } ] @@ -3757,7 +3951,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -3900,7 +4094,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -3970,7 +4164,7 @@ }, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes" } } @@ -3980,7 +4174,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -4033,7 +4227,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 182, + "line": 191, "character": 2 } ], @@ -4056,7 +4250,7 @@ "flags": {}, "type": { "type": "reference", - "id": 505, + "id": 526, "name": "GoTrueClientOptions" } } @@ -4081,7 +4275,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 132, + "line": 138, "character": 2 } ], @@ -4103,18 +4297,18 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 136, + "line": 142, "character": 2 } ], "type": { "type": "reference", - "id": 972, + "id": 993, "name": "GoTrueMFAApi" } }, { - "id": 144, + "id": 147, "name": "exchangeCodeForSession", "kind": 2048, "kindString": "Method", @@ -4122,13 +4316,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 584, + "line": 593, "character": 8 } ], "signatures": [ { - "id": 145, + "id": 148, "name": "exchangeCodeForSession", "kind": 4096, "kindString": "Call signature", @@ -4138,7 +4332,7 @@ }, "parameters": [ { - "id": 146, + "id": 149, "name": "authCode", "kind": 32768, "kindString": "Parameter", @@ -4154,7 +4348,7 @@ "typeArguments": [ { "type": "reference", - "id": 574, + "id": 595, "name": "AuthTokenResponse" } ], @@ -4166,7 +4360,358 @@ ] }, { - "id": 183, + "id": 477, + "name": "getClaims", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2636, + "character": 8 + } + ], + "signatures": [ + { + "id": 478, + "name": "getClaims", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "experimental", + "text": "This method may change in future versions." + }, + { + "tag": "description", + "text": "Gets the claims from a JWT. If the JWT is symmetric JWTs, it will call getUser() to verify against the server. If the JWT is asymmetric, it will be verified against the JWKS using the WebCrypto API.\n" + } + ] + }, + "parameters": [ + { + "id": 479, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 480, + "name": "jwks", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 481, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 482, + "name": "keys", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2638, + "character": 12 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 1133, + "name": "JWK" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [482] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 484, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 485, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "claims", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 1129, + "name": "JwtPayload" + } + }, + { + "id": 487, + "name": "header", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 36 + } + ], + "type": { + "type": "reference", + "id": 1114, + "name": "JwtHeader" + } + }, + { + "id": 488, + "name": "signature", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 55 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Uint8Array", + "package": "typescript", + "name": "Uint8Array" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [486, 487, 488] + } + ] + } + } + }, + { + "id": 489, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2642, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [484, 489] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 490, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 491, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2644, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 492, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2644, + "character": 20 + } + ], + "type": { + "type": "reference", + "id": 1158, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [491, 492] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 493, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 494, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2645, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 495, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2645, + "character": 20 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [494, 495] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 186, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -4174,13 +4719,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 935, + "line": 944, "character": 8 } ], "signatures": [ { - "id": 184, + "id": 187, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -4198,158 +4743,18 @@ { "type": "reflection", "declaration": { - "id": 185, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ - { - "id": 186, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1028, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 188, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1029, - "character": 14 - } - ], - "type": { - "type": "reference", - "id": 635, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [188] - } - ] - } - } - }, { "id": 189, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1031, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186, 189] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 191, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1034, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1035, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [193] - } - ] - } - } - }, - { - "id": 194, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -4357,55 +4762,17 @@ "character": 12 } ], - "type": { - "type": "reference", - "id": 1111, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [191, 194] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 195, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 196, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1040, - "character": 12 - } - ], "type": { "type": "reflection", "declaration": { - "id": 197, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 191, "name": "session", "kind": 1024, "kindString": "Property", @@ -4413,13 +4780,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1041, + "line": 1038, "character": 14 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 656, + "name": "Session" } } ], @@ -4427,14 +4795,14 @@ { "title": "Properties", "kind": 1024, - "children": [198] + "children": [191] } ] } } }, { - "id": 199, + "id": 192, "name": "error", "kind": 1024, "kindString": "Property", @@ -4442,7 +4810,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1043, + "line": 1040, "character": 12 } ], @@ -4456,7 +4824,184 @@ { "title": "Properties", "kind": 1024, - "children": [196, 199] + "children": [189, 192] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 193, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 194, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1043, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 195, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 196, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1044, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [196] + } + ] + } + } + }, + { + "id": 197, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1046, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 1158, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [194, 197] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 198, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 199, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1049, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 200, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 201, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1050, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [201] + } + ] + } + } + }, + { + "id": 202, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1052, + "character": 12 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [199, 202] } ] } @@ -4472,7 +5017,7 @@ ] }, { - "id": 246, + "id": 249, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -4480,13 +5025,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1166, + "line": 1175, "character": 8 } ], "signatures": [ { - "id": 247, + "id": 250, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -4496,7 +5041,7 @@ }, "parameters": [ { - "id": 248, + "id": 251, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -4517,7 +5062,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -4529,7 +5074,7 @@ ] }, { - "id": 362, + "id": 358, "name": "getUserIdentities", "kind": 2048, "kindString": "Method", @@ -4537,13 +5082,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1735, + "line": 1733, "character": 8 } ], "signatures": [ { - "id": 363, + "id": 359, "name": "getUserIdentities", "kind": 4096, "kindString": "Call signature", @@ -4560,14 +5105,14 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 361, "name": "data", "kind": 1024, "kindString": "Property", @@ -4575,21 +5120,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1737, + "line": 1735, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 366, + "id": 362, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 367, + "id": 363, "name": "identities", "kind": 1024, "kindString": "Property", @@ -4597,7 +5142,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1738, + "line": 1736, "character": 10 } ], @@ -4605,7 +5150,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } @@ -4615,18 +5160,55 @@ { "title": "Properties", "kind": 1024, - "children": [367] + "children": [363] } ] } } }, { - "id": 368, + "id": 364, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1738, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [361, 364] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 365, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 366, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -4638,46 +5220,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 368] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 370, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1742, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 371, + "id": 367, "name": "error", "kind": 1024, "kindString": "Property", @@ -4685,13 +5230,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1742, + "line": 1740, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -4700,7 +5245,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [366, 367] } ] } @@ -4716,7 +5261,7 @@ ] }, { - "id": 128, + "id": 131, "name": "initialize", "kind": 2048, "kindString": "Method", @@ -4724,13 +5269,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 286, + "line": 295, "character": 8 } ], "signatures": [ { - "id": 129, + "id": 132, "name": "initialize", "kind": 4096, "kindString": "Call signature", @@ -4743,7 +5288,7 @@ "typeArguments": [ { "type": "reference", - "id": 1031, + "id": 1052, "name": "InitializeResult" } ], @@ -4755,7 +5300,7 @@ ] }, { - "id": 372, + "id": 368, "name": "linkIdentity", "kind": 2048, "kindString": "Method", @@ -4763,13 +5308,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1759, + "line": 1757, "character": 8 } ], "signatures": [ { - "id": 373, + "id": 369, "name": "linkIdentity", "kind": 4096, "kindString": "Call signature", @@ -4779,14 +5324,14 @@ }, "parameters": [ { - "id": 374, + "id": 370, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials" } } @@ -4796,7 +5341,7 @@ "typeArguments": [ { "type": "reference", - "id": 602, + "id": 623, "name": "OAuthResponse" } ], @@ -4808,7 +5353,7 @@ ] }, { - "id": 334, + "id": 330, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -4816,13 +5361,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1633, + "line": 1631, "character": 2 } ], "signatures": [ { - "id": 335, + "id": 331, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -4832,7 +5377,7 @@ }, "parameters": [ { - "id": 336, + "id": 332, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -4843,33 +5388,33 @@ "type": { "type": "reflection", "declaration": { - "id": 337, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 338, + "id": 334, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 339, + "id": 335, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent" } }, { - "id": 340, + "id": 336, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -4883,7 +5428,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -4920,14 +5465,14 @@ "type": { "type": "reflection", "declaration": { - "id": 341, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 338, "name": "data", "kind": 1024, "kindString": "Property", @@ -4935,21 +5480,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1636, + "line": 1634, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 343, + "id": 339, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 344, + "id": 340, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -4957,13 +5502,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1636, + "line": 1634, "character": 12 } ], "type": { "type": "reference", - "id": 718, + "id": 739, "name": "Subscription" } } @@ -4972,7 +5517,7 @@ { "title": "Properties", "kind": 1024, - "children": [344] + "children": [340] } ] } @@ -4983,7 +5528,7 @@ { "title": "Properties", "kind": 1024, - "children": [342] + "children": [338] } ] } @@ -4992,7 +5537,7 @@ ] }, { - "id": 176, + "id": 179, "name": "reauthenticate", "kind": 2048, "kindString": "Method", @@ -5000,13 +5545,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 851, + "line": 860, "character": 8 } ], "signatures": [ { - "id": 177, + "id": 180, "name": "reauthenticate", "kind": 4096, "kindString": "Call signature", @@ -5019,7 +5564,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -5031,7 +5576,7 @@ ] }, { - "id": 283, + "id": 279, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -5039,13 +5584,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1382, + "line": 1380, "character": 8 } ], "signatures": [ { - "id": 284, + "id": 280, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -5055,7 +5600,7 @@ }, "parameters": [ { - "id": 285, + "id": 281, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -5068,14 +5613,14 @@ "type": { "type": "reflection", "declaration": { - "id": 286, + "id": 282, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 283, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -5083,7 +5628,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1382, + "line": 1380, "character": 42 } ], @@ -5097,7 +5642,7 @@ { "title": "Properties", "kind": 1024, - "children": [287] + "children": [283] } ] } @@ -5109,7 +5654,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -5121,7 +5666,7 @@ ] }, { - "id": 180, + "id": 183, "name": "resend", "kind": 2048, "kindString": "Method", @@ -5129,13 +5674,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 886, + "line": 895, "character": 8 } ], "signatures": [ { - "id": 181, + "id": 184, "name": "resend", "kind": 4096, "kindString": "Call signature", @@ -5145,14 +5690,14 @@ }, "parameters": [ { - "id": 182, + "id": 185, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 824, + "id": 845, "name": "ResendParams" } } @@ -5162,7 +5707,7 @@ "typeArguments": [ { "type": "reference", - "id": 559, + "id": 580, "name": "AuthOtpResponse" } ], @@ -5174,7 +5719,7 @@ ] }, { - "id": 348, + "id": 344, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -5182,13 +5727,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1689, + "line": 1687, "character": 8 } ], "signatures": [ { - "id": 349, + "id": 345, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -5198,7 +5743,7 @@ }, "parameters": [ { - "id": 350, + "id": 346, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -5212,7 +5757,7 @@ } }, { - "id": 351, + "id": 347, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5220,14 +5765,14 @@ "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 350, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -5240,7 +5785,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1693, + "line": 1691, "character": 6 } ], @@ -5250,7 +5795,7 @@ } }, { - "id": 353, + "id": 349, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -5263,7 +5808,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1692, + "line": 1690, "character": 6 } ], @@ -5277,7 +5822,7 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [350, 349] } ] } @@ -5291,6 +5836,67 @@ { "type": "union", "types": [ + { + "type": "reflection", + "declaration": { + "id": 351, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 352, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1695, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 353, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 354, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1696, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [352, 354] + } + ] + } + }, { "type": "reflection", "declaration": { @@ -5306,30 +5912,6 @@ "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1697, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 357, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 358, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -5341,46 +5923,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [356, 358] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1700, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 361, + "id": 357, "name": "error", "kind": 1024, "kindString": "Property", @@ -5388,13 +5933,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1700, + "line": 1698, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -5403,7 +5948,7 @@ { "title": "Properties", "kind": 1024, - "children": [360, 361] + "children": [356, 357] } ] } @@ -5419,7 +5964,7 @@ ] }, { - "id": 271, + "id": 267, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -5427,13 +5972,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1307, + "line": 1305, "character": 8 } ], "signatures": [ { - "id": 272, + "id": 268, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -5443,7 +5988,7 @@ }, "parameters": [ { - "id": 273, + "id": 269, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -5454,14 +5999,14 @@ "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 275, + "id": 271, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -5469,7 +6014,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1308, + "line": 1306, "character": 4 } ], @@ -5479,7 +6024,7 @@ } }, { - "id": 276, + "id": 272, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -5487,7 +6032,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1309, + "line": 1307, "character": 4 } ], @@ -5501,7 +6046,7 @@ { "title": "Properties", "kind": 1024, - "children": [275, 276] + "children": [271, 272] } ] } @@ -5513,7 +6058,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -5525,7 +6070,7 @@ ] }, { - "id": 132, + "id": 135, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", @@ -5533,13 +6078,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 389, + "line": 398, "character": 8 } ], "signatures": [ { - "id": 133, + "id": 136, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", @@ -5550,7 +6095,7 @@ }, "parameters": [ { - "id": 134, + "id": 137, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -5559,7 +6104,7 @@ }, "type": { "type": "reference", - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials" } } @@ -5569,7 +6114,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -5580,135 +6125,28 @@ } ] }, - { - "id": 164, - "name": "signInWithIdToken", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 644, - "character": 8 - } - ], - "signatures": [ - { - "id": 165, - "name": "signInWithIdToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." - }, - "parameters": [ - { - "id": 166, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 792, - "name": "SignInWithIdTokenCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 574, - "name": "AuthTokenResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 141, - "name": "signInWithOAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 572, - "character": 8 - } - ], - "signatures": [ - { - "id": 142, - "name": "signInWithOAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." - }, - "parameters": [ - { - "id": 143, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 780, - "name": "SignInWithOAuthCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 602, - "name": "OAuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, { "id": 167, - "name": "signInWithOtp", + "name": "signInWithIdToken", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 699, + "line": 653, "character": 8 } ], "signatures": [ { "id": 168, - "name": "signInWithOtp", + "name": "signInWithIdToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).", - "text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed.\n" + "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." }, "parameters": [ { @@ -5719,7 +6157,114 @@ "flags": {}, "type": { "type": "reference", - "id": 762, + "id": 813, + "name": "SignInWithIdTokenCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 595, + "name": "AuthTokenResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 144, + "name": "signInWithOAuth", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 581, + "character": 8 + } + ], + "signatures": [ + { + "id": 145, + "name": "signInWithOAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." + }, + "parameters": [ + { + "id": 146, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 801, + "name": "SignInWithOAuthCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 623, + "name": "OAuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 170, + "name": "signInWithOtp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 708, + "character": 8 + } + ], + "signatures": [ + { + "id": 171, + "name": "signInWithOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in a user using magiclink or a one-time password (OTP).", + "text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed.\n" + }, + "parameters": [ + { + "id": 172, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 783, "name": "SignInWithPasswordlessCredentials" } } @@ -5729,7 +6274,7 @@ "typeArguments": [ { "type": "reference", - "id": 559, + "id": 580, "name": "AuthOtpResponse" } ], @@ -5741,7 +6286,7 @@ ] }, { - "id": 138, + "id": 141, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -5749,13 +6294,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 509, + "line": 518, "character": 8 } ], "signatures": [ { - "id": 139, + "id": 142, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -5766,14 +6311,14 @@ }, "parameters": [ { - "id": 140, + "id": 143, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials" } } @@ -5783,7 +6328,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 608, "name": "AuthTokenResponsePassword" } ], @@ -5795,7 +6340,7 @@ ] }, { - "id": 173, + "id": 176, "name": "signInWithSSO", "kind": 2048, "kindString": "Method", @@ -5803,13 +6348,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 813, + "line": 822, "character": 8 } ], "signatures": [ { - "id": 174, + "id": 177, "name": "signInWithSSO", "kind": 4096, "kindString": "Call signature", @@ -5820,14 +6365,14 @@ }, "parameters": [ { - "id": 175, + "id": 178, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 838, + "id": 859, "name": "SignInWithSSO" } } @@ -5837,7 +6382,7 @@ "typeArguments": [ { "type": "reference", - "id": 615, + "id": 636, "name": "SSOResponse" } ], @@ -5849,7 +6394,7 @@ ] }, { - "id": 324, + "id": 320, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -5857,13 +6402,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1589, + "line": 1587, "character": 8 } ], "signatures": [ { - "id": 325, + "id": 321, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -5874,14 +6419,14 @@ }, "parameters": [ { - "id": 326, + "id": 322, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1052, + "id": 1073, "name": "SignOut" }, "defaultValue": "..." @@ -5893,14 +6438,14 @@ { "type": "reflection", "declaration": { - "id": 327, + "id": 323, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 328, + "id": 324, "name": "error", "kind": 1024, "kindString": "Property", @@ -5908,7 +6453,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1589, + "line": 1587, "character": 67 } ], @@ -5921,7 +6466,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -5932,7 +6477,7 @@ { "title": "Properties", "kind": 1024, - "children": [328] + "children": [324] } ] } @@ -5946,7 +6491,7 @@ ] }, { - "id": 135, + "id": 138, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -5954,13 +6499,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 432, + "line": 441, "character": 8 } ], "signatures": [ { - "id": 136, + "id": 139, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -5972,14 +6517,14 @@ }, "parameters": [ { - "id": 137, + "id": 140, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials" } } @@ -5989,7 +6534,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -6001,7 +6546,7 @@ ] }, { - "id": 430, + "id": 426, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -6009,13 +6554,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2174, + "line": 2172, "character": 8 } ], "signatures": [ { - "id": 431, + "id": 427, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -6040,7 +6585,7 @@ ] }, { - "id": 432, + "id": 428, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -6048,13 +6593,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2187, + "line": 2185, "character": 8 } ], "signatures": [ { - "id": 433, + "id": 429, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -6079,7 +6624,7 @@ ] }, { - "id": 375, + "id": 371, "name": "unlinkIdentity", "kind": 2048, "kindString": "Method", @@ -6087,13 +6632,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1795, + "line": 1793, "character": 8 } ], "signatures": [ { - "id": 376, + "id": 372, "name": "unlinkIdentity", "kind": 4096, "kindString": "Call signature", @@ -6103,14 +6648,14 @@ }, "parameters": [ { - "id": 377, + "id": 373, "name": "identity", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } @@ -6121,6 +6666,67 @@ { "type": "union", "types": [ + { + "type": "reflection", + "declaration": { + "id": 374, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1795, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 376, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 377, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1796, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [375, 377] + } + ] + } + }, { "type": "reflection", "declaration": { @@ -6136,30 +6742,6 @@ "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1797, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 380, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 381, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -6171,46 +6753,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [379, 381] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 383, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1800, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 384, + "id": 380, "name": "error", "kind": 1024, "kindString": "Property", @@ -6218,13 +6763,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1800, + "line": 1798, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -6233,7 +6778,7 @@ { "title": "Properties", "kind": 1024, - "children": [383, 384] + "children": [379, 380] } ] } @@ -6249,7 +6794,7 @@ ] }, { - "id": 252, + "id": 255, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -6257,13 +6802,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1227, + "line": 1236, "character": 8 } ], "signatures": [ { - "id": 253, + "id": 256, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -6273,19 +6818,19 @@ }, "parameters": [ { - "id": 254, + "id": 257, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" } }, { - "id": 255, + "id": 258, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6293,14 +6838,14 @@ "type": { "type": "reflection", "declaration": { - "id": 256, + "id": 259, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 260, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -6310,7 +6855,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1230, + "line": 1239, "character": 6 } ], @@ -6324,7 +6869,7 @@ { "title": "Properties", "kind": 1024, - "children": [257] + "children": [260] } ] } @@ -6337,7 +6882,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -6349,7 +6894,7 @@ ] }, { - "id": 170, + "id": 173, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -6357,13 +6902,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 752, + "line": 761, "character": 8 } ], "signatures": [ { - "id": 171, + "id": 174, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -6373,14 +6918,14 @@ }, "parameters": [ { - "id": 172, + "id": 175, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 802, + "id": 823, "name": "VerifyOtpParams" } } @@ -6390,7 +6935,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -6417,42 +6962,42 @@ "title": "Methods", "kind": 2048, "children": [ - 144, 183, 246, 362, 128, 372, 334, 176, 283, 180, 348, 271, 132, 164, 141, 167, 138, - 173, 324, 135, 430, 432, 375, 252, 170 + 147, 477, 186, 249, 358, 131, 368, 330, 179, 279, 183, 344, 267, 135, 167, 144, 170, + 141, 176, 320, 138, 426, 428, 371, 255, 173 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 123, + "line": 129, "character": 21 } ] }, { - "id": 485, + "id": 506, "name": "NavigatorLockAcquireTimeoutError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 486, + "id": 507, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 487, + "id": 508, "name": "new NavigatorLockAcquireTimeoutError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 488, + "id": 509, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -6465,7 +7010,7 @@ ], "type": { "type": "reference", - "id": 485, + "id": 506, "name": "NavigatorLockAcquireTimeoutError" }, "inheritedFrom": { @@ -6480,7 +7025,7 @@ } }, { - "id": 489, + "id": 510, "name": "isAcquireTimeout", "kind": 1024, "kindString": "Property", @@ -6510,12 +7055,12 @@ { "title": "Constructors", "kind": 512, - "children": [486] + "children": [507] }, { "title": "Properties", "kind": 1024, - "children": [489] + "children": [510] } ], "sources": [ @@ -6533,7 +7078,7 @@ ] }, { - "id": 644, + "id": 665, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -6550,7 +7095,7 @@ }, "children": [ { - "id": 645, + "id": 666, "name": "method", "kind": 1024, "kindString": "Property", @@ -6582,7 +7127,7 @@ { "type": "reflection", "declaration": { - "id": 646, + "id": 667, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6607,7 +7152,7 @@ } }, { - "id": 647, + "id": 668, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -6632,7 +7177,7 @@ { "title": "Properties", "kind": 1024, - "children": [645, 647] + "children": [666, 668] } ], "sources": [ @@ -6644,14 +7189,14 @@ ] }, { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -6675,7 +7220,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -6699,7 +7244,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -6726,7 +7271,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -6750,7 +7295,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -6774,7 +7319,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -6802,7 +7347,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -6829,7 +7374,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -6853,7 +7398,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -6880,7 +7425,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -6904,7 +7449,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -6928,7 +7473,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -6956,7 +7501,7 @@ { "title": "Properties", "kind": 1024, - "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] + "children": [728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727] } ], "sources": [ @@ -6972,7 +7517,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -6987,7 +7532,7 @@ ] }, { - "id": 660, + "id": 681, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -7011,7 +7556,7 @@ }, "children": [ { - "id": 666, + "id": 687, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -7029,7 +7574,7 @@ } }, { - "id": 663, + "id": 684, "name": "factor_type", "kind": 1024, "kindString": "Property", @@ -7057,7 +7602,7 @@ { "type": "reflection", "declaration": { - "id": 664, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7078,7 +7623,7 @@ } }, { - "id": 662, + "id": 683, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -7101,7 +7646,7 @@ } }, { - "id": 661, + "id": 682, "name": "id", "kind": 1024, "kindString": "Property", @@ -7122,7 +7667,7 @@ } }, { - "id": 665, + "id": 686, "name": "status", "kind": 1024, "kindString": "Property", @@ -7152,7 +7697,7 @@ } }, { - "id": 667, + "id": 688, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -7174,7 +7719,7 @@ { "title": "Properties", "kind": 1024, - "children": [666, 663, 662, 661, 665, 667] + "children": [687, 684, 683, 682, 686, 688] } ], "sources": [ @@ -7186,14 +7731,14 @@ ] }, { - "id": 873, + "id": 894, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 874, + "id": 895, "name": "data", "kind": 1024, "kindString": "Property", @@ -7217,7 +7762,7 @@ } }, { - "id": 875, + "id": 896, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -7244,7 +7789,7 @@ { "title": "Properties", "kind": 1024, - "children": [874, 875] + "children": [895, 896] } ], "sources": [ @@ -7256,7 +7801,7 @@ ] }, { - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -7272,14 +7817,14 @@ }, "children": [ { - "id": 1025, + "id": 1046, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1026, + "id": 1047, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -7299,14 +7844,14 @@ }, "parameters": [ { - "id": 1027, + "id": 1048, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams" } } @@ -7316,7 +7861,7 @@ "typeArguments": [ { "type": "reference", - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -7328,14 +7873,14 @@ ] }, { - "id": 1022, + "id": 1043, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1023, + "id": 1044, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -7345,14 +7890,14 @@ }, "parameters": [ { - "id": 1024, + "id": 1045, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams" } } @@ -7362,7 +7907,7 @@ "typeArguments": [ { "type": "reference", - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -7378,7 +7923,7 @@ { "title": "Methods", "kind": 2048, - "children": [1025, 1022] + "children": [1046, 1043] } ], "sources": [ @@ -7390,7 +7935,7 @@ ] }, { - "id": 972, + "id": 993, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -7400,14 +7945,14 @@ }, "children": [ { - "id": 980, + "id": 1001, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 1002, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -7417,14 +7962,14 @@ }, "parameters": [ { - "id": 982, + "id": 1003, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 907, + "id": 928, "name": "MFAChallengeParams" } } @@ -7434,7 +7979,7 @@ "typeArguments": [ { "type": "reference", - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse" } ], @@ -7446,14 +7991,14 @@ ] }, { - "id": 989, + "id": 1010, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 990, + "id": 1011, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -7463,14 +8008,14 @@ }, "parameters": [ { - "id": 991, + "id": 1012, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams" } } @@ -7480,7 +8025,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -7492,14 +8037,14 @@ ] }, { - "id": 973, + "id": 994, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 974, + "id": 995, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -7510,14 +8055,14 @@ }, "parameters": [ { - "id": 975, + "id": 996, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams" } } @@ -7527,7 +8072,7 @@ "typeArguments": [ { "type": "reference", - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse" } ], @@ -7537,21 +8082,21 @@ } }, { - "id": 976, + "id": 997, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 977, + "id": 998, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams" } } @@ -7561,7 +8106,7 @@ "typeArguments": [ { "type": "reference", - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse" } ], @@ -7571,21 +8116,21 @@ } }, { - "id": 978, + "id": 999, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 979, + "id": 1000, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 898, + "id": 919, "name": "MFAEnrollParams" } } @@ -7595,7 +8140,7 @@ "typeArguments": [ { "type": "reference", - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse" } ], @@ -7607,14 +8152,14 @@ ] }, { - "id": 994, + "id": 1015, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 995, + "id": 1016, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -7628,7 +8173,7 @@ "typeArguments": [ { "type": "reference", - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -7640,14 +8185,14 @@ ] }, { - "id": 992, + "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 993, + "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -7674,7 +8219,7 @@ "typeArguments": [ { "type": "reference", - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse" } ], @@ -7686,14 +8231,14 @@ ] }, { - "id": 986, + "id": 1007, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 987, + "id": 1008, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -7703,14 +8248,14 @@ }, "parameters": [ { - "id": 988, + "id": 1009, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 899, + "id": 920, "name": "MFAUnenrollParams" } } @@ -7720,7 +8265,7 @@ "typeArguments": [ { "type": "reference", - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse" } ], @@ -7732,14 +8277,14 @@ ] }, { - "id": 983, + "id": 1004, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 1005, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -7749,14 +8294,14 @@ }, "parameters": [ { - "id": 985, + "id": 1006, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 902, + "id": 923, "name": "MFAVerifyParams" } } @@ -7766,7 +8311,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -7782,7 +8327,7 @@ { "title": "Methods", "kind": 2048, - "children": [980, 989, 973, 994, 992, 986, 983] + "children": [1001, 1010, 994, 1015, 1013, 1007, 1004] } ], "sources": [ @@ -7794,14 +8339,152 @@ ] }, { - "id": 635, + "id": 1133, + "name": "JWK", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 1136, + "name": "alg", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1227, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1135, + "name": "key_ops", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1226, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1137, + "name": "kid", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1228, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1134, + "name": "kty", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1225, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "RSA" + }, + { + "type": "literal", + "value": "EC" + }, + { + "type": "literal", + "value": "oct" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1136, 1135, 1137, 1134] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1224, + "character": 17 + } + ], + "indexSignature": { + "id": 1138, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 1139, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 656, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 638, + "id": 659, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -7822,7 +8505,7 @@ } }, { - "id": 641, + "id": 662, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -7845,7 +8528,7 @@ } }, { - "id": 640, + "id": 661, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -7866,7 +8549,7 @@ } }, { - "id": 637, + "id": 658, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -7898,7 +8581,7 @@ } }, { - "id": 636, + "id": 657, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -7930,7 +8613,7 @@ } }, { - "id": 639, + "id": 660, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -7951,7 +8634,7 @@ } }, { - "id": 642, + "id": 663, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -7969,7 +8652,7 @@ } }, { - "id": 643, + "id": 664, "name": "user", "kind": 1024, "kindString": "Property", @@ -7983,7 +8666,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -7992,7 +8675,7 @@ { "title": "Properties", "kind": 1024, - "children": [638, 641, 640, 637, 636, 639, 642, 643] + "children": [659, 662, 661, 658, 657, 660, 663, 664] } ], "sources": [ @@ -8004,14 +8687,14 @@ ] }, { - "id": 718, + "id": 739, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 719, + "id": 740, "name": "id", "kind": 1024, "kindString": "Property", @@ -8032,7 +8715,7 @@ } }, { - "id": 720, + "id": 741, "name": "callback", "kind": 2048, "kindString": "Method", @@ -8046,7 +8729,7 @@ ], "signatures": [ { - "id": 721, + "id": 742, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -8056,19 +8739,19 @@ }, "parameters": [ { - "id": 722, + "id": 743, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent" } }, { - "id": 723, + "id": 744, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -8082,7 +8765,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -8097,7 +8780,7 @@ ] }, { - "id": 724, + "id": 745, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -8111,7 +8794,7 @@ ], "signatures": [ { - "id": 725, + "id": 746, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -8131,12 +8814,12 @@ { "title": "Properties", "kind": 1024, - "children": [719] + "children": [740] }, { "title": "Methods", "kind": 2048, - "children": [720, 724] + "children": [741, 745] } ], "sources": [ @@ -8148,14 +8831,14 @@ ] }, { - "id": 675, + "id": 696, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 686, + "id": 707, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -8175,7 +8858,7 @@ } }, { - "id": 677, + "id": 698, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -8189,12 +8872,12 @@ ], "type": { "type": "reference", - "id": 668, + "id": 689, "name": "UserAppMetadata" } }, { - "id": 679, + "id": 700, "name": "aud", "kind": 1024, "kindString": "Property", @@ -8212,7 +8895,7 @@ } }, { - "id": 680, + "id": 701, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -8232,7 +8915,7 @@ } }, { - "id": 690, + "id": 711, "name": "confirmed_at", "kind": 1024, "kindString": "Property", @@ -8252,7 +8935,7 @@ } }, { - "id": 689, + "id": 710, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -8270,7 +8953,7 @@ } }, { - "id": 687, + "id": 708, "name": "email", "kind": 1024, "kindString": "Property", @@ -8290,7 +8973,7 @@ } }, { - "id": 682, + "id": 703, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", @@ -8310,7 +8993,7 @@ } }, { - "id": 691, + "id": 712, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", @@ -8330,7 +9013,7 @@ } }, { - "id": 698, + "id": 719, "name": "factors", "kind": 1024, "kindString": "Property", @@ -8348,13 +9031,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 676, + "id": 697, "name": "id", "kind": 1024, "kindString": "Property", @@ -8372,7 +9055,7 @@ } }, { - "id": 696, + "id": 717, "name": "identities", "kind": 1024, "kindString": "Property", @@ -8390,13 +9073,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } }, { - "id": 685, + "id": 706, "name": "invited_at", "kind": 1024, "kindString": "Property", @@ -8416,7 +9099,7 @@ } }, { - "id": 697, + "id": 718, "name": "is_anonymous", "kind": 1024, "kindString": "Property", @@ -8436,7 +9119,7 @@ } }, { - "id": 693, + "id": 714, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -8456,7 +9139,7 @@ } }, { - "id": 683, + "id": 704, "name": "new_email", "kind": 1024, "kindString": "Property", @@ -8476,7 +9159,7 @@ } }, { - "id": 684, + "id": 705, "name": "new_phone", "kind": 1024, "kindString": "Property", @@ -8496,7 +9179,7 @@ } }, { - "id": 688, + "id": 709, "name": "phone", "kind": 1024, "kindString": "Property", @@ -8516,7 +9199,7 @@ } }, { - "id": 692, + "id": 713, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", @@ -8536,7 +9219,7 @@ } }, { - "id": 681, + "id": 702, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -8556,7 +9239,7 @@ } }, { - "id": 694, + "id": 715, "name": "role", "kind": 1024, "kindString": "Property", @@ -8576,7 +9259,7 @@ } }, { - "id": 695, + "id": 716, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -8596,7 +9279,7 @@ } }, { - "id": 678, + "id": 699, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -8610,7 +9293,7 @@ ], "type": { "type": "reference", - "id": 672, + "id": 693, "name": "UserMetadata" } } @@ -8620,8 +9303,8 @@ "title": "Properties", "kind": 1024, "children": [ - 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, 684, - 688, 692, 681, 694, 695, 678 + 707, 698, 700, 701, 711, 710, 708, 703, 712, 719, 697, 717, 706, 718, 714, 704, 705, + 709, 713, 702, 715, 716, 699 ] } ], @@ -8634,14 +9317,14 @@ ] }, { - "id": 668, + "id": 689, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 669, + "id": 690, "name": "provider", "kind": 1024, "kindString": "Property", @@ -8665,7 +9348,7 @@ { "title": "Properties", "kind": 1024, - "children": [669] + "children": [690] } ], "sources": [ @@ -8676,14 +9359,14 @@ } ], "indexSignature": { - "id": 670, + "id": 691, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 692, "name": "key", "kind": 32768, "flags": {}, @@ -8700,14 +9383,14 @@ } }, { - "id": 699, + "id": 720, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 704, + "id": 725, "name": "data", "kind": 1024, "kindString": "Property", @@ -8731,7 +9414,7 @@ } }, { - "id": 700, + "id": 721, "name": "email", "kind": 1024, "kindString": "Property", @@ -8754,7 +9437,7 @@ } }, { - "id": 703, + "id": 724, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -8778,7 +9461,7 @@ } }, { - "id": 702, + "id": 723, "name": "password", "kind": 1024, "kindString": "Property", @@ -8801,7 +9484,7 @@ } }, { - "id": 701, + "id": 722, "name": "phone", "kind": 1024, "kindString": "Property", @@ -8828,7 +9511,7 @@ { "title": "Properties", "kind": 1024, - "children": [704, 700, 703, 702, 701] + "children": [725, 721, 724, 723, 722] } ], "sources": [ @@ -8840,14 +9523,14 @@ ] }, { - "id": 648, + "id": 669, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 657, + "id": 678, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -8867,7 +9550,7 @@ } }, { - "id": 649, + "id": 670, "name": "id", "kind": 1024, "kindString": "Property", @@ -8885,7 +9568,7 @@ } }, { - "id": 651, + "id": 672, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -8902,20 +9585,20 @@ "type": { "type": "reflection", "declaration": { - "id": 652, + "id": 673, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 653, + "id": 674, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 654, + "id": 675, "name": "key", "kind": 32768, "flags": {}, @@ -8934,7 +9617,7 @@ } }, { - "id": 655, + "id": 676, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -8952,7 +9635,7 @@ } }, { - "id": 658, + "id": 679, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -8972,7 +9655,7 @@ } }, { - "id": 656, + "id": 677, "name": "provider", "kind": 1024, "kindString": "Property", @@ -8990,7 +9673,7 @@ } }, { - "id": 659, + "id": 680, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -9010,7 +9693,7 @@ } }, { - "id": 650, + "id": 671, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -9032,7 +9715,7 @@ { "title": "Properties", "kind": 1024, - "children": [657, 649, 651, 655, 658, 656, 659, 650] + "children": [678, 670, 672, 676, 679, 677, 680, 671] } ], "sources": [ @@ -9044,7 +9727,7 @@ ] }, { - "id": 672, + "id": 693, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -9057,14 +9740,14 @@ } ], "indexSignature": { - "id": 673, + "id": 694, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 674, + "id": 695, "name": "key", "kind": 32768, "flags": {}, @@ -9081,14 +9764,14 @@ } }, { - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 812, + "id": 833, "name": "email", "kind": 1024, "kindString": "Property", @@ -9109,7 +9792,7 @@ } }, { - "id": 815, + "id": 836, "name": "options", "kind": 1024, "kindString": "Property", @@ -9126,14 +9809,14 @@ "type": { "type": "reflection", "declaration": { - "id": 816, + "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 818, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -9162,7 +9845,7 @@ } }, { - "id": 817, + "id": 838, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -9189,14 +9872,14 @@ { "title": "Properties", "kind": 1024, - "children": [818, 817] + "children": [839, 838] } ] } } }, { - "id": 813, + "id": 834, "name": "token", "kind": 1024, "kindString": "Property", @@ -9217,7 +9900,7 @@ } }, { - "id": 814, + "id": 835, "name": "type", "kind": 1024, "kindString": "Property", @@ -9234,7 +9917,7 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType" } } @@ -9243,7 +9926,7 @@ { "title": "Properties", "kind": 1024, - "children": [812, 815, 813, 814] + "children": [833, 836, 834, 835] } ], "sources": [ @@ -9255,14 +9938,14 @@ ] }, { - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -9279,14 +9962,14 @@ "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -9315,7 +9998,7 @@ } }, { - "id": 809, + "id": 830, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -9342,14 +10025,14 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ] } } }, { - "id": 804, + "id": 825, "name": "phone", "kind": 1024, "kindString": "Property", @@ -9370,7 +10053,7 @@ } }, { - "id": 805, + "id": 826, "name": "token", "kind": 1024, "kindString": "Property", @@ -9391,7 +10074,7 @@ } }, { - "id": 806, + "id": 827, "name": "type", "kind": 1024, "kindString": "Property", @@ -9408,7 +10091,7 @@ ], "type": { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType" } } @@ -9417,7 +10100,7 @@ { "title": "Properties", "kind": 1024, - "children": [807, 804, 805, 806] + "children": [828, 825, 826, 827] } ], "sources": [ @@ -9429,14 +10112,14 @@ ] }, { - "id": 819, + "id": 840, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -9457,7 +10140,7 @@ } }, { - "id": 821, + "id": 842, "name": "type", "kind": 1024, "kindString": "Property", @@ -9474,7 +10157,7 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType" } } @@ -9483,7 +10166,7 @@ { "title": "Properties", "kind": 1024, - "children": [820, 821] + "children": [841, 842] } ], "sources": [ @@ -9495,7 +10178,7 @@ ] }, { - "id": 495, + "id": 516, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -9536,14 +10219,14 @@ }, { "type": "reference", - "id": 494, + "id": 515, "name": "AuthChangeEventMFA" } ] } }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -9561,7 +10244,7 @@ } }, { - "id": 779, + "id": 800, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -9588,7 +10271,7 @@ } }, { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -9611,14 +10294,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -9639,7 +10322,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -9664,7 +10347,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -9678,7 +10361,7 @@ } }, { - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", @@ -9704,14 +10387,14 @@ { "type": "reflection", "declaration": { - "id": 997, + "id": 1018, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1019, "name": "data", "kind": 1024, "kindString": "Property", @@ -9726,14 +10409,14 @@ "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1000, + "id": 1021, "name": "id", "kind": 1024, "kindString": "Property", @@ -9758,7 +10441,7 @@ { "title": "Properties", "kind": 1024, - "children": [1000] + "children": [1021] } ], "sources": [ @@ -9772,7 +10455,7 @@ } }, { - "id": 1001, + "id": 1022, "name": "error", "kind": 1024, "kindString": "Property", @@ -9794,7 +10477,7 @@ { "title": "Properties", "kind": 1024, - "children": [998, 1001] + "children": [1019, 1022] } ], "sources": [ @@ -9809,14 +10492,14 @@ { "type": "reflection", "declaration": { - "id": 1002, + "id": 1023, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1003, + "id": 1024, "name": "data", "kind": 1024, "kindString": "Property", @@ -9834,7 +10517,7 @@ } }, { - "id": 1004, + "id": 1025, "name": "error", "kind": 1024, "kindString": "Property", @@ -9848,7 +10531,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -9857,7 +10540,7 @@ { "title": "Properties", "kind": 1024, - "children": [1003, 1004] + "children": [1024, 1025] } ], "sources": [ @@ -9873,7 +10556,7 @@ } }, { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -9896,14 +10579,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -9928,7 +10611,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -9942,7 +10625,7 @@ } }, { - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -9968,14 +10651,14 @@ { "type": "reflection", "declaration": { - "id": 1010, + "id": 1031, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1032, "name": "data", "kind": 1024, "kindString": "Property", @@ -9990,14 +10673,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1012, + "id": 1033, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1013, + "id": 1034, "name": "factors", "kind": 1024, "kindString": "Property", @@ -10016,7 +10699,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } @@ -10026,7 +10709,7 @@ { "title": "Properties", "kind": 1024, - "children": [1013] + "children": [1034] } ], "sources": [ @@ -10040,7 +10723,7 @@ } }, { - "id": 1014, + "id": 1035, "name": "error", "kind": 1024, "kindString": "Property", @@ -10062,7 +10745,7 @@ { "title": "Properties", "kind": 1024, - "children": [1011, 1014] + "children": [1032, 1035] } ], "sources": [ @@ -10077,14 +10760,14 @@ { "type": "reflection", "declaration": { - "id": 1015, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1016, + "id": 1037, "name": "data", "kind": 1024, "kindString": "Property", @@ -10102,7 +10785,7 @@ } }, { - "id": 1017, + "id": 1038, "name": "error", "kind": 1024, "kindString": "Property", @@ -10116,7 +10799,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -10125,7 +10808,7 @@ { "title": "Properties", "kind": 1024, - "children": [1016, 1017] + "children": [1037, 1038] } ], "sources": [ @@ -10141,7 +10824,7 @@ } }, { - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -10159,14 +10842,14 @@ { "type": "reflection", "declaration": { - "id": 939, + "id": 960, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 940, + "id": 961, "name": "data", "kind": 1024, "kindString": "Property", @@ -10181,14 +10864,14 @@ "type": { "type": "reflection", "declaration": { - "id": 941, + "id": 962, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 944, + "id": 965, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -10209,7 +10892,7 @@ } }, { - "id": 942, + "id": 963, "name": "id", "kind": 1024, "kindString": "Property", @@ -10230,7 +10913,7 @@ } }, { - "id": 943, + "id": 964, "name": "type", "kind": 1024, "kindString": "Property", @@ -10264,7 +10947,7 @@ { "title": "Properties", "kind": 1024, - "children": [944, 942, 943] + "children": [965, 963, 964] } ], "sources": [ @@ -10278,7 +10961,7 @@ } }, { - "id": 945, + "id": 966, "name": "error", "kind": 1024, "kindString": "Property", @@ -10300,7 +10983,7 @@ { "title": "Properties", "kind": 1024, - "children": [940, 945] + "children": [961, 966] } ], "sources": [ @@ -10315,14 +10998,14 @@ { "type": "reflection", "declaration": { - "id": 946, + "id": 967, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 947, + "id": 968, "name": "data", "kind": 1024, "kindString": "Property", @@ -10340,7 +11023,7 @@ } }, { - "id": 948, + "id": 969, "name": "error", "kind": 1024, "kindString": "Property", @@ -10354,7 +11037,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -10363,7 +11046,7 @@ { "title": "Properties", "kind": 1024, - "children": [947, 948] + "children": [968, 969] } ], "sources": [ @@ -10379,7 +11062,7 @@ } }, { - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -10397,14 +11080,14 @@ { "type": "reflection", "declaration": { - "id": 1082, + "id": 1103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1083, + "id": 1104, "name": "data", "kind": 1024, "kindString": "Property", @@ -10419,14 +11102,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1084, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1087, + "id": 1108, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -10449,7 +11132,7 @@ } }, { - "id": 1085, + "id": 1106, "name": "id", "kind": 1024, "kindString": "Property", @@ -10470,7 +11153,7 @@ } }, { - "id": 1088, + "id": 1109, "name": "phone", "kind": 1024, "kindString": "Property", @@ -10491,7 +11174,7 @@ } }, { - "id": 1086, + "id": 1107, "name": "type", "kind": 1024, "kindString": "Property", @@ -10516,7 +11199,7 @@ { "title": "Properties", "kind": 1024, - "children": [1087, 1085, 1088, 1086] + "children": [1108, 1106, 1109, 1107] } ], "sources": [ @@ -10530,7 +11213,7 @@ } }, { - "id": 1089, + "id": 1110, "name": "error", "kind": 1024, "kindString": "Property", @@ -10552,7 +11235,7 @@ { "title": "Properties", "kind": 1024, - "children": [1083, 1089] + "children": [1104, 1110] } ], "sources": [ @@ -10567,14 +11250,14 @@ { "type": "reflection", "declaration": { - "id": 1090, + "id": 1111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1091, + "id": 1112, "name": "data", "kind": 1024, "kindString": "Property", @@ -10592,7 +11275,7 @@ } }, { - "id": 1092, + "id": 1113, "name": "error", "kind": 1024, "kindString": "Property", @@ -10606,7 +11289,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -10615,7 +11298,7 @@ { "title": "Properties", "kind": 1024, - "children": [1091, 1092] + "children": [1112, 1113] } ], "sources": [ @@ -10631,7 +11314,7 @@ } }, { - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -10648,19 +11331,19 @@ "types": [ { "type": "reference", - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse" }, { "type": "reference", - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse" } ] } }, { - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -10678,14 +11361,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1087, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1088, "name": "data", "kind": 1024, "kindString": "Property", @@ -10700,14 +11383,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1068, + "id": 1089, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1076, + "id": 1097, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -10730,7 +11413,7 @@ } }, { - "id": 1069, + "id": 1090, "name": "id", "kind": 1024, "kindString": "Property", @@ -10751,7 +11434,7 @@ } }, { - "id": 1071, + "id": 1092, "name": "totp", "kind": 1024, "kindString": "Property", @@ -10769,14 +11452,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1073, + "id": 1094, "name": "qr_code", "kind": 1024, "kindString": "Property", @@ -10797,7 +11480,7 @@ } }, { - "id": 1074, + "id": 1095, "name": "secret", "kind": 1024, "kindString": "Property", @@ -10818,7 +11501,7 @@ } }, { - "id": 1075, + "id": 1096, "name": "uri", "kind": 1024, "kindString": "Property", @@ -10843,7 +11526,7 @@ { "title": "Properties", "kind": 1024, - "children": [1073, 1074, 1075] + "children": [1094, 1095, 1096] } ], "sources": [ @@ -10857,7 +11540,7 @@ } }, { - "id": 1070, + "id": 1091, "name": "type", "kind": 1024, "kindString": "Property", @@ -10882,7 +11565,7 @@ { "title": "Properties", "kind": 1024, - "children": [1076, 1069, 1071, 1070] + "children": [1097, 1090, 1092, 1091] } ], "sources": [ @@ -10896,7 +11579,7 @@ } }, { - "id": 1077, + "id": 1098, "name": "error", "kind": 1024, "kindString": "Property", @@ -10918,7 +11601,7 @@ { "title": "Properties", "kind": 1024, - "children": [1067, 1077] + "children": [1088, 1098] } ], "sources": [ @@ -10933,14 +11616,14 @@ { "type": "reflection", "declaration": { - "id": 1078, + "id": 1099, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1079, + "id": 1100, "name": "data", "kind": 1024, "kindString": "Property", @@ -10958,7 +11641,7 @@ } }, { - "id": 1080, + "id": 1101, "name": "error", "kind": 1024, "kindString": "Property", @@ -10972,7 +11655,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -10981,7 +11664,7 @@ { "title": "Properties", "kind": 1024, - "children": [1079, 1080] + "children": [1100, 1101] } ], "sources": [ @@ -10997,7 +11680,7 @@ } }, { - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -11015,14 +11698,14 @@ { "type": "reflection", "declaration": { - "id": 962, + "id": 983, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 963, + "id": 984, "name": "data", "kind": 1024, "kindString": "Property", @@ -11037,14 +11720,14 @@ "type": { "type": "reflection", "declaration": { - "id": 964, + "id": 985, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 967, + "id": 988, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", @@ -11063,13 +11746,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 644, + "id": 665, "name": "AMREntry" } } }, { - "id": 965, + "id": 986, "name": "currentLevel", "kind": 1024, "kindString": "Property", @@ -11089,7 +11772,7 @@ "types": [ { "type": "reference", - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels" }, { @@ -11100,7 +11783,7 @@ } }, { - "id": 966, + "id": 987, "name": "nextLevel", "kind": 1024, "kindString": "Property", @@ -11126,7 +11809,7 @@ "types": [ { "type": "reference", - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels" }, { @@ -11141,7 +11824,7 @@ { "title": "Properties", "kind": 1024, - "children": [967, 965, 966] + "children": [988, 986, 987] } ], "sources": [ @@ -11155,7 +11838,7 @@ } }, { - "id": 968, + "id": 989, "name": "error", "kind": 1024, "kindString": "Property", @@ -11177,7 +11860,7 @@ { "title": "Properties", "kind": 1024, - "children": [963, 968] + "children": [984, 989] } ], "sources": [ @@ -11192,14 +11875,14 @@ { "type": "reflection", "declaration": { - "id": 969, + "id": 990, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 970, + "id": 991, "name": "data", "kind": 1024, "kindString": "Property", @@ -11217,7 +11900,7 @@ } }, { - "id": 971, + "id": 992, "name": "error", "kind": 1024, "kindString": "Property", @@ -11231,7 +11914,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -11240,7 +11923,7 @@ { "title": "Properties", "kind": 1024, - "children": [970, 971] + "children": [991, 992] } ], "sources": [ @@ -11256,7 +11939,7 @@ } }, { - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -11274,14 +11957,14 @@ { "type": "reflection", "declaration": { - "id": 950, + "id": 971, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 951, + "id": 972, "name": "data", "kind": 1024, "kindString": "Property", @@ -11296,14 +11979,14 @@ "type": { "type": "reflection", "declaration": { - "id": 952, + "id": 973, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 953, + "id": 974, "name": "all", "kind": 1024, "kindString": "Property", @@ -11322,13 +12005,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 955, + "id": 976, "name": "phone", "kind": 1024, "kindString": "Property", @@ -11347,13 +12030,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 954, + "id": 975, "name": "totp", "kind": 1024, "kindString": "Property", @@ -11372,7 +12055,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } @@ -11382,7 +12065,7 @@ { "title": "Properties", "kind": 1024, - "children": [953, 955, 954] + "children": [974, 976, 975] } ], "sources": [ @@ -11396,7 +12079,7 @@ } }, { - "id": 956, + "id": 977, "name": "error", "kind": 1024, "kindString": "Property", @@ -11418,7 +12101,7 @@ { "title": "Properties", "kind": 1024, - "children": [951, 956] + "children": [972, 977] } ], "sources": [ @@ -11433,14 +12116,14 @@ { "type": "reflection", "declaration": { - "id": 957, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 979, "name": "data", "kind": 1024, "kindString": "Property", @@ -11458,7 +12141,7 @@ } }, { - "id": 959, + "id": 980, "name": "error", "kind": 1024, "kindString": "Property", @@ -11472,7 +12155,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -11481,7 +12164,7 @@ { "title": "Properties", "kind": 1024, - "children": [958, 959] + "children": [979, 980] } ], "sources": [ @@ -11497,7 +12180,7 @@ } }, { - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -11515,14 +12198,14 @@ { "type": "reflection", "declaration": { - "id": 930, + "id": 951, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 952, "name": "data", "kind": 1024, "kindString": "Property", @@ -11537,14 +12220,14 @@ "type": { "type": "reflection", "declaration": { - "id": 932, + "id": 953, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 933, + "id": 954, "name": "id", "kind": 1024, "kindString": "Property", @@ -11569,7 +12252,7 @@ { "title": "Properties", "kind": 1024, - "children": [933] + "children": [954] } ], "sources": [ @@ -11583,7 +12266,7 @@ } }, { - "id": 934, + "id": 955, "name": "error", "kind": 1024, "kindString": "Property", @@ -11605,7 +12288,7 @@ { "title": "Properties", "kind": 1024, - "children": [931, 934] + "children": [952, 955] } ], "sources": [ @@ -11620,14 +12303,14 @@ { "type": "reflection", "declaration": { - "id": 935, + "id": 956, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 936, + "id": 957, "name": "data", "kind": 1024, "kindString": "Property", @@ -11645,7 +12328,7 @@ } }, { - "id": 937, + "id": 958, "name": "error", "kind": 1024, "kindString": "Property", @@ -11659,7 +12342,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -11668,7 +12351,7 @@ { "title": "Properties", "kind": 1024, - "children": [936, 937] + "children": [957, 958] } ], "sources": [ @@ -11684,7 +12367,7 @@ } }, { - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -11702,14 +12385,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 937, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 938, "name": "data", "kind": 1024, "kindString": "Property", @@ -11724,14 +12407,14 @@ "type": { "type": "reflection", "declaration": { - "id": 918, + "id": 939, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 919, + "id": 940, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -11752,7 +12435,7 @@ } }, { - "id": 921, + "id": 942, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -11773,7 +12456,7 @@ } }, { - "id": 922, + "id": 943, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -11794,7 +12477,7 @@ } }, { - "id": 920, + "id": 941, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -11815,7 +12498,7 @@ } }, { - "id": 923, + "id": 944, "name": "user", "kind": 1024, "kindString": "Property", @@ -11832,7 +12515,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -11841,7 +12524,7 @@ { "title": "Properties", "kind": 1024, - "children": [919, 921, 922, 920, 923] + "children": [940, 942, 943, 941, 944] } ], "sources": [ @@ -11855,7 +12538,7 @@ } }, { - "id": 924, + "id": 945, "name": "error", "kind": 1024, "kindString": "Property", @@ -11877,7 +12560,7 @@ { "title": "Properties", "kind": 1024, - "children": [917, 924] + "children": [938, 945] } ], "sources": [ @@ -11892,14 +12575,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 946, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 947, "name": "data", "kind": 1024, "kindString": "Property", @@ -11917,7 +12600,7 @@ } }, { - "id": 927, + "id": 948, "name": "error", "kind": 1024, "kindString": "Property", @@ -11931,7 +12614,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -11940,7 +12623,7 @@ { "title": "Properties", "kind": 1024, - "children": [926, 927] + "children": [947, 948] } ], "sources": [ @@ -11956,7 +12639,7 @@ } }, { - "id": 559, + "id": 580, "name": "AuthOtpResponse", "kind": 4194304, "kindString": "Type alias", @@ -11978,14 +12661,14 @@ { "type": "reflection", "declaration": { - "id": 560, + "id": 581, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 561, + "id": 582, "name": "data", "kind": 1024, "kindString": "Property", @@ -12000,14 +12683,14 @@ "type": { "type": "reflection", "declaration": { - "id": 562, + "id": 583, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 565, + "id": 586, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -12036,7 +12719,7 @@ } }, { - "id": 564, + "id": 585, "name": "session", "kind": 1024, "kindString": "Property", @@ -12054,7 +12737,7 @@ } }, { - "id": 563, + "id": 584, "name": "user", "kind": 1024, "kindString": "Property", @@ -12076,7 +12759,7 @@ { "title": "Properties", "kind": 1024, - "children": [565, 564, 563] + "children": [586, 585, 584] } ], "sources": [ @@ -12090,7 +12773,7 @@ } }, { - "id": 566, + "id": 587, "name": "error", "kind": 1024, "kindString": "Property", @@ -12112,7 +12795,7 @@ { "title": "Properties", "kind": 1024, - "children": [561, 566] + "children": [582, 587] } ], "sources": [ @@ -12127,14 +12810,14 @@ { "type": "reflection", "declaration": { - "id": 567, + "id": 588, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 589, "name": "data", "kind": 1024, "kindString": "Property", @@ -12149,14 +12832,14 @@ "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 590, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 572, + "id": 593, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -12185,7 +12868,7 @@ } }, { - "id": 571, + "id": 592, "name": "session", "kind": 1024, "kindString": "Property", @@ -12203,7 +12886,7 @@ } }, { - "id": 570, + "id": 591, "name": "user", "kind": 1024, "kindString": "Property", @@ -12225,7 +12908,7 @@ { "title": "Properties", "kind": 1024, - "children": [572, 571, 570] + "children": [593, 592, 591] } ], "sources": [ @@ -12239,7 +12922,7 @@ } }, { - "id": 573, + "id": 594, "name": "error", "kind": 1024, "kindString": "Property", @@ -12253,7 +12936,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -12262,7 +12945,7 @@ { "title": "Properties", "kind": 1024, - "children": [568, 573] + "children": [589, 594] } ], "sources": [ @@ -12278,7 +12961,7 @@ } }, { - "id": 532, + "id": 553, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -12296,14 +12979,14 @@ { "type": "reflection", "declaration": { - "id": 533, + "id": 554, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 534, + "id": 555, "name": "data", "kind": 1024, "kindString": "Property", @@ -12318,14 +13001,14 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 537, + "id": 558, "name": "session", "kind": 1024, "kindString": "Property", @@ -12342,7 +13025,7 @@ "types": [ { "type": "reference", - "id": 635, + "id": 656, "name": "Session" }, { @@ -12353,7 +13036,7 @@ } }, { - "id": 536, + "id": 557, "name": "user", "kind": 1024, "kindString": "Property", @@ -12370,7 +13053,7 @@ "types": [ { "type": "reference", - "id": 675, + "id": 696, "name": "User" }, { @@ -12385,7 +13068,7 @@ { "title": "Properties", "kind": 1024, - "children": [537, 536] + "children": [558, 557] } ], "sources": [ @@ -12399,7 +13082,7 @@ } }, { - "id": 538, + "id": 559, "name": "error", "kind": 1024, "kindString": "Property", @@ -12421,7 +13104,7 @@ { "title": "Properties", "kind": 1024, - "children": [534, 538] + "children": [555, 559] } ], "sources": [ @@ -12436,14 +13119,14 @@ { "type": "reflection", "declaration": { - "id": 539, + "id": 560, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 540, + "id": 561, "name": "data", "kind": 1024, "kindString": "Property", @@ -12458,14 +13141,14 @@ "type": { "type": "reflection", "declaration": { - "id": 541, + "id": 562, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 543, + "id": 564, "name": "session", "kind": 1024, "kindString": "Property", @@ -12483,7 +13166,7 @@ } }, { - "id": 542, + "id": 563, "name": "user", "kind": 1024, "kindString": "Property", @@ -12505,7 +13188,7 @@ { "title": "Properties", "kind": 1024, - "children": [543, 542] + "children": [564, 563] } ], "sources": [ @@ -12519,7 +13202,7 @@ } }, { - "id": 544, + "id": 565, "name": "error", "kind": 1024, "kindString": "Property", @@ -12533,7 +13216,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -12542,7 +13225,7 @@ { "title": "Properties", "kind": 1024, - "children": [540, 544] + "children": [561, 565] } ], "sources": [ @@ -12558,7 +13241,7 @@ } }, { - "id": 545, + "id": 566, "name": "AuthResponsePassword", "kind": 4194304, "kindString": "Type alias", @@ -12576,14 +13259,14 @@ { "type": "reflection", "declaration": { - "id": 546, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 547, + "id": 568, "name": "data", "kind": 1024, "kindString": "Property", @@ -12598,14 +13281,14 @@ "type": { "type": "reflection", "declaration": { - "id": 548, + "id": 569, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 571, "name": "session", "kind": 1024, "kindString": "Property", @@ -12622,7 +13305,7 @@ "types": [ { "type": "reference", - "id": 635, + "id": 656, "name": "Session" }, { @@ -12633,7 +13316,7 @@ } }, { - "id": 549, + "id": 570, "name": "user", "kind": 1024, "kindString": "Property", @@ -12650,7 +13333,7 @@ "types": [ { "type": "reference", - "id": 675, + "id": 696, "name": "User" }, { @@ -12661,7 +13344,7 @@ } }, { - "id": 551, + "id": 572, "name": "weak_password", "kind": 1024, "kindString": "Property", @@ -12680,7 +13363,7 @@ "types": [ { "type": "reference", - "id": 528, + "id": 549, "name": "WeakPassword" }, { @@ -12695,7 +13378,7 @@ { "title": "Properties", "kind": 1024, - "children": [550, 549, 551] + "children": [571, 570, 572] } ], "sources": [ @@ -12709,7 +13392,7 @@ } }, { - "id": 552, + "id": 573, "name": "error", "kind": 1024, "kindString": "Property", @@ -12731,7 +13414,7 @@ { "title": "Properties", "kind": 1024, - "children": [547, 552] + "children": [568, 573] } ], "sources": [ @@ -12746,14 +13429,14 @@ { "type": "reflection", "declaration": { - "id": 553, + "id": 574, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 554, + "id": 575, "name": "data", "kind": 1024, "kindString": "Property", @@ -12768,14 +13451,14 @@ "type": { "type": "reflection", "declaration": { - "id": 555, + "id": 576, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 557, + "id": 578, "name": "session", "kind": 1024, "kindString": "Property", @@ -12793,7 +13476,7 @@ } }, { - "id": 556, + "id": 577, "name": "user", "kind": 1024, "kindString": "Property", @@ -12815,7 +13498,7 @@ { "title": "Properties", "kind": 1024, - "children": [557, 556] + "children": [578, 577] } ], "sources": [ @@ -12829,7 +13512,7 @@ } }, { - "id": 558, + "id": 579, "name": "error", "kind": 1024, "kindString": "Property", @@ -12843,7 +13526,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -12852,7 +13535,7 @@ { "title": "Properties", "kind": 1024, - "children": [554, 558] + "children": [575, 579] } ], "sources": [ @@ -12868,7 +13551,7 @@ } }, { - "id": 574, + "id": 595, "name": "AuthTokenResponse", "kind": 4194304, "kindString": "Type alias", @@ -12886,14 +13569,14 @@ { "type": "reflection", "declaration": { - "id": 575, + "id": 596, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 576, + "id": 597, "name": "data", "kind": 1024, "kindString": "Property", @@ -12908,14 +13591,14 @@ "type": { "type": "reflection", "declaration": { - "id": 577, + "id": 598, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 579, + "id": 600, "name": "session", "kind": 1024, "kindString": "Property", @@ -12929,12 +13612,12 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } }, { - "id": 578, + "id": 599, "name": "user", "kind": 1024, "kindString": "Property", @@ -12948,7 +13631,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -12957,7 +13640,7 @@ { "title": "Properties", "kind": 1024, - "children": [579, 578] + "children": [600, 599] } ], "sources": [ @@ -12971,7 +13654,7 @@ } }, { - "id": 580, + "id": 601, "name": "error", "kind": 1024, "kindString": "Property", @@ -12993,7 +13676,7 @@ { "title": "Properties", "kind": 1024, - "children": [576, 580] + "children": [597, 601] } ], "sources": [ @@ -13008,14 +13691,14 @@ { "type": "reflection", "declaration": { - "id": 581, + "id": 602, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 603, "name": "data", "kind": 1024, "kindString": "Property", @@ -13030,14 +13713,14 @@ "type": { "type": "reflection", "declaration": { - "id": 583, + "id": 604, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 585, + "id": 606, "name": "session", "kind": 1024, "kindString": "Property", @@ -13055,7 +13738,7 @@ } }, { - "id": 584, + "id": 605, "name": "user", "kind": 1024, "kindString": "Property", @@ -13077,7 +13760,7 @@ { "title": "Properties", "kind": 1024, - "children": [585, 584] + "children": [606, 605] } ], "sources": [ @@ -13091,7 +13774,7 @@ } }, { - "id": 586, + "id": 607, "name": "error", "kind": 1024, "kindString": "Property", @@ -13105,7 +13788,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -13114,7 +13797,7 @@ { "title": "Properties", "kind": 1024, - "children": [582, 586] + "children": [603, 607] } ], "sources": [ @@ -13130,7 +13813,7 @@ } }, { - "id": 587, + "id": 608, "name": "AuthTokenResponsePassword", "kind": 4194304, "kindString": "Type alias", @@ -13148,14 +13831,14 @@ { "type": "reflection", "declaration": { - "id": 588, + "id": 609, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 589, + "id": 610, "name": "data", "kind": 1024, "kindString": "Property", @@ -13170,14 +13853,14 @@ "type": { "type": "reflection", "declaration": { - "id": 590, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 592, + "id": 613, "name": "session", "kind": 1024, "kindString": "Property", @@ -13191,12 +13874,12 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } }, { - "id": 591, + "id": 612, "name": "user", "kind": 1024, "kindString": "Property", @@ -13210,12 +13893,12 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } }, { - "id": 593, + "id": 614, "name": "weakPassword", "kind": 1024, "kindString": "Property", @@ -13231,7 +13914,7 @@ ], "type": { "type": "reference", - "id": 528, + "id": 549, "name": "WeakPassword" } } @@ -13240,7 +13923,7 @@ { "title": "Properties", "kind": 1024, - "children": [592, 591, 593] + "children": [613, 612, 614] } ], "sources": [ @@ -13254,7 +13937,7 @@ } }, { - "id": 594, + "id": 615, "name": "error", "kind": 1024, "kindString": "Property", @@ -13276,7 +13959,7 @@ { "title": "Properties", "kind": 1024, - "children": [589, 594] + "children": [610, 615] } ], "sources": [ @@ -13291,14 +13974,14 @@ { "type": "reflection", "declaration": { - "id": 595, + "id": 616, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 596, + "id": 617, "name": "data", "kind": 1024, "kindString": "Property", @@ -13313,14 +13996,14 @@ "type": { "type": "reflection", "declaration": { - "id": 597, + "id": 618, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 599, + "id": 620, "name": "session", "kind": 1024, "kindString": "Property", @@ -13338,7 +14021,7 @@ } }, { - "id": 598, + "id": 619, "name": "user", "kind": 1024, "kindString": "Property", @@ -13356,7 +14039,7 @@ } }, { - "id": 600, + "id": 621, "name": "weakPassword", "kind": 1024, "kindString": "Property", @@ -13380,7 +14063,7 @@ { "title": "Properties", "kind": 1024, - "children": [599, 598, 600] + "children": [620, 619, 621] } ], "sources": [ @@ -13394,7 +14077,7 @@ } }, { - "id": 601, + "id": 622, "name": "error", "kind": 1024, "kindString": "Property", @@ -13408,7 +14091,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -13417,7 +14100,7 @@ { "title": "Properties", "kind": 1024, - "children": [596, 601] + "children": [617, 622] } ], "sources": [ @@ -13433,7 +14116,7 @@ } }, { - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -13460,7 +14143,7 @@ } }, { - "id": 1034, + "id": 1055, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -13478,14 +14161,14 @@ { "type": "reflection", "declaration": { - "id": 1035, + "id": 1056, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1037, + "id": 1058, "name": "error", "kind": 1024, "kindString": "Property", @@ -13503,7 +14186,7 @@ } }, { - "id": 1036, + "id": 1057, "name": "session", "kind": 1024, "kindString": "Property", @@ -13517,7 +14200,7 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } } @@ -13526,7 +14209,7 @@ { "title": "Properties", "kind": 1024, - "children": [1037, 1036] + "children": [1058, 1057] } ], "sources": [ @@ -13541,14 +14224,14 @@ { "type": "reflection", "declaration": { - "id": 1038, + "id": 1059, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1040, + "id": 1061, "name": "error", "kind": 1024, "kindString": "Property", @@ -13562,12 +14245,12 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } }, { - "id": 1039, + "id": 1060, "name": "session", "kind": 1024, "kindString": "Property", @@ -13589,7 +14272,7 @@ { "title": "Properties", "kind": 1024, - "children": [1040, 1039] + "children": [1061, 1060] } ], "sources": [ @@ -13605,7 +14288,7 @@ } }, { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -13648,7 +14331,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -13663,14 +14346,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -13691,7 +14374,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -13712,7 +14395,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -13731,7 +14414,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -13745,7 +14428,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -13776,7 +14459,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -13790,7 +14473,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -13805,14 +14488,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -13833,7 +14516,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -13852,7 +14535,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -13875,7 +14558,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -13906,7 +14589,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -13920,7 +14603,7 @@ } }, { - "id": 876, + "id": 897, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -13937,29 +14620,29 @@ "types": [ { "type": "reference", - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams" }, { "type": "reference", - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams" }, { "type": "reference", - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams" }, { "type": "reference", - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams" } ] } }, { - "id": 890, + "id": 911, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -13977,14 +14660,14 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 913, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -14005,7 +14688,7 @@ } }, { - "id": 893, + "id": 914, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -14026,7 +14709,7 @@ } }, { - "id": 894, + "id": 915, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -14047,7 +14730,7 @@ } }, { - "id": 895, + "id": 916, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -14068,7 +14751,7 @@ } }, { - "id": 896, + "id": 917, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -14085,7 +14768,7 @@ ], "type": { "type": "reference", - "id": 897, + "id": 918, "name": "GenerateLinkType" } } @@ -14094,7 +14777,7 @@ { "title": "Properties", "kind": 1024, - "children": [892, 893, 894, 895, 896] + "children": [913, 914, 915, 916, 917] } ], "sources": [ @@ -14108,7 +14791,7 @@ } }, { - "id": 877, + "id": 898, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -14126,14 +14809,14 @@ { "type": "reflection", "declaration": { - "id": 878, + "id": 899, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 900, "name": "data", "kind": 1024, "kindString": "Property", @@ -14148,14 +14831,14 @@ "type": { "type": "reflection", "declaration": { - "id": 880, + "id": 901, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 881, + "id": 902, "name": "properties", "kind": 1024, "kindString": "Property", @@ -14169,12 +14852,12 @@ ], "type": { "type": "reference", - "id": 890, + "id": 911, "name": "GenerateLinkProperties" } }, { - "id": 882, + "id": 903, "name": "user", "kind": 1024, "kindString": "Property", @@ -14188,7 +14871,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -14197,7 +14880,7 @@ { "title": "Properties", "kind": 1024, - "children": [881, 882] + "children": [902, 903] } ], "sources": [ @@ -14211,7 +14894,7 @@ } }, { - "id": 883, + "id": 904, "name": "error", "kind": 1024, "kindString": "Property", @@ -14233,7 +14916,7 @@ { "title": "Properties", "kind": 1024, - "children": [879, 883] + "children": [900, 904] } ], "sources": [ @@ -14248,14 +14931,14 @@ { "type": "reflection", "declaration": { - "id": 884, + "id": 905, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 885, + "id": 906, "name": "data", "kind": 1024, "kindString": "Property", @@ -14270,14 +14953,14 @@ "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 907, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 887, + "id": 908, "name": "properties", "kind": 1024, "kindString": "Property", @@ -14295,7 +14978,7 @@ } }, { - "id": 888, + "id": 909, "name": "user", "kind": 1024, "kindString": "Property", @@ -14317,7 +15000,7 @@ { "title": "Properties", "kind": 1024, - "children": [887, 888] + "children": [908, 909] } ], "sources": [ @@ -14331,7 +15014,7 @@ } }, { - "id": 889, + "id": 910, "name": "error", "kind": 1024, "kindString": "Property", @@ -14345,7 +15028,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -14354,7 +15037,7 @@ { "title": "Properties", "kind": 1024, - "children": [885, 889] + "children": [906, 910] } ], "sources": [ @@ -14370,7 +15053,7 @@ } }, { - "id": 897, + "id": 918, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -14413,7 +15096,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14428,14 +15111,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -14456,7 +15139,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -14475,7 +15158,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -14489,7 +15172,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -14511,7 +15194,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -14525,7 +15208,7 @@ } }, { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14540,14 +15223,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -14565,7 +15248,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -14584,7 +15267,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -14607,7 +15290,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -14625,7 +15308,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -14647,7 +15330,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -14661,7 +15344,7 @@ } }, { - "id": 505, + "id": 526, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -14676,14 +15359,14 @@ "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 535, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -14703,7 +15386,7 @@ } }, { - "id": 519, + "id": 540, "name": "debug", "kind": 1024, "kindString": "Property", @@ -14727,7 +15410,7 @@ { "type": "reflection", "declaration": { - "id": 520, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14741,14 +15424,14 @@ ], "signatures": [ { - "id": 521, + "id": 542, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 522, + "id": 543, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -14759,7 +15442,7 @@ } }, { - "id": 523, + "id": 544, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -14787,7 +15470,7 @@ } }, { - "id": 513, + "id": 534, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -14807,7 +15490,7 @@ } }, { - "id": 517, + "id": 538, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -14827,7 +15510,7 @@ } }, { - "id": 518, + "id": 539, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -14843,12 +15526,12 @@ ], "type": { "type": "reference", - "id": 779, + "id": 800, "name": "AuthFlowType" } }, { - "id": 525, + "id": 546, "name": "hasCustomAuthorizationHeader", "kind": 1024, "kindString": "Property", @@ -14877,7 +15560,7 @@ } }, { - "id": 508, + "id": 529, "name": "headers", "kind": 1024, "kindString": "Property", @@ -14894,7 +15577,7 @@ "type": { "type": "reflection", "declaration": { - "id": 509, + "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14907,14 +15590,14 @@ } ], "indexSignature": { - "id": 510, + "id": 531, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 511, + "id": 532, "name": "key", "kind": 32768, "flags": {}, @@ -14933,7 +15616,7 @@ } }, { - "id": 524, + "id": 545, "name": "lock", "kind": 1024, "kindString": "Property", @@ -14958,12 +15641,12 @@ ], "type": { "type": "reference", - "id": 496, + "id": 517, "name": "LockFunc" } }, { - "id": 515, + "id": 536, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -14983,7 +15666,7 @@ } }, { - "id": 516, + "id": 537, "name": "storage", "kind": 1024, "kindString": "Property", @@ -14999,12 +15682,12 @@ ], "type": { "type": "reference", - "id": 1028, + "id": 1049, "name": "SupportedStorage" } }, { - "id": 512, + "id": 533, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -15024,7 +15707,7 @@ } }, { - "id": 507, + "id": 528, "name": "url", "kind": 1024, "kindString": "Property", @@ -15048,7 +15731,7 @@ { "title": "Properties", "kind": 1024, - "children": [514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507] + "children": [535, 540, 534, 538, 539, 546, 529, 545, 536, 537, 533, 528] } ], "sources": [ @@ -15062,7 +15745,7 @@ } }, { - "id": 1031, + "id": 1052, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -15077,14 +15760,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1032, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1033, + "id": 1054, "name": "error", "kind": 1024, "kindString": "Property", @@ -15101,7 +15784,7 @@ "types": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" }, { @@ -15116,7 +15799,7 @@ { "title": "Properties", "kind": 1024, - "children": [1033] + "children": [1054] } ], "sources": [ @@ -15130,7 +15813,178 @@ } }, { - "id": 496, + "id": 1114, + "name": "JwtHeader", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1203, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1115, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1116, + "name": "alg", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1204, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "RS256" + }, + { + "type": "literal", + "value": "ES256" + }, + { + "type": "literal", + "value": "HS256" + } + ] + } + }, + { + "id": 1117, + "name": "kid", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1205, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1118, + "name": "typ", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1206, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1116, 1117, 1118] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1203, + "character": 24 + } + ] + } + } + }, + { + "id": 1129, + "name": "JwtPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1220, + "character": 12 + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "id": 1119, + "name": "RequiredClaims" + }, + { + "type": "reflection", + "declaration": { + "id": 1130, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1220, + "character": 42 + } + ], + "indexSignature": { + "id": 1131, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 1132, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + ] + } + }, + { + "id": 517, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -15145,7 +15999,7 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -15159,7 +16013,7 @@ ], "signatures": [ { - "id": 498, + "id": 519, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -15175,7 +16029,7 @@ }, "typeParameter": [ { - "id": 504, + "id": 525, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -15184,7 +16038,7 @@ ], "parameters": [ { - "id": 499, + "id": 520, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -15198,7 +16052,7 @@ } }, { - "id": 500, + "id": 521, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -15212,7 +16066,7 @@ } }, { - "id": 501, + "id": 522, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -15223,7 +16077,7 @@ "type": { "type": "reflection", "declaration": { - "id": 502, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -15237,7 +16091,7 @@ ], "signatures": [ { - "id": 503, + "id": 524, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -15247,7 +16101,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -15266,7 +16120,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -15280,7 +16134,7 @@ } }, { - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -15295,14 +16149,14 @@ "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 933, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 914, + "id": 935, "name": "code", "kind": 1024, "kindString": "Property", @@ -15323,7 +16177,7 @@ } }, { - "id": 913, + "id": 934, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -15348,7 +16202,7 @@ { "title": "Properties", "kind": 1024, - "children": [914, 913] + "children": [935, 934] } ], "sources": [ @@ -15362,7 +16216,7 @@ } }, { - "id": 907, + "id": 928, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -15377,14 +16231,14 @@ "type": { "type": "reflection", "declaration": { - "id": 908, + "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 910, + "id": 931, "name": "channel", "kind": 1024, "kindString": "Property", @@ -15416,7 +16270,7 @@ } }, { - "id": 909, + "id": 930, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -15441,7 +16295,7 @@ { "title": "Properties", "kind": 1024, - "children": [910, 909] + "children": [931, 930] } ], "sources": [ @@ -15455,7 +16309,7 @@ } }, { - "id": 898, + "id": 919, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -15472,19 +16326,19 @@ "types": [ { "type": "reference", - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams" }, { "type": "reference", - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams" } ] } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -15499,14 +16353,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -15527,7 +16381,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -15550,7 +16404,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -15575,7 +16429,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -15589,7 +16443,7 @@ } }, { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -15604,14 +16458,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -15632,7 +16486,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -15655,7 +16509,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -15682,7 +16536,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -15696,7 +16550,7 @@ } }, { - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -15711,14 +16565,14 @@ "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 922, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -15743,7 +16597,7 @@ { "title": "Properties", "kind": 1024, - "children": [901] + "children": [922] } ], "sources": [ @@ -15757,7 +16611,7 @@ } }, { - "id": 902, + "id": 923, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -15772,14 +16626,14 @@ "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 924, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 926, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -15800,7 +16654,7 @@ } }, { - "id": 906, + "id": 927, "name": "code", "kind": 1024, "kindString": "Property", @@ -15821,7 +16675,7 @@ } }, { - "id": 904, + "id": 925, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -15846,7 +16700,7 @@ { "title": "Properties", "kind": 1024, - "children": [905, 906, 904] + "children": [926, 927, 925] } ], "sources": [ @@ -15860,7 +16714,7 @@ } }, { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -15887,7 +16741,7 @@ } }, { - "id": 602, + "id": 623, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -15905,14 +16759,14 @@ { "type": "reflection", "declaration": { - "id": 603, + "id": 624, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 604, + "id": 625, "name": "data", "kind": 1024, "kindString": "Property", @@ -15927,14 +16781,14 @@ "type": { "type": "reflection", "declaration": { - "id": 605, + "id": 626, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 606, + "id": 627, "name": "provider", "kind": 1024, "kindString": "Property", @@ -15948,12 +16802,12 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider" } }, { - "id": 607, + "id": 628, "name": "url", "kind": 1024, "kindString": "Property", @@ -15975,7 +16829,7 @@ { "title": "Properties", "kind": 1024, - "children": [606, 607] + "children": [627, 628] } ], "sources": [ @@ -15989,7 +16843,7 @@ } }, { - "id": 608, + "id": 629, "name": "error", "kind": 1024, "kindString": "Property", @@ -16011,7 +16865,7 @@ { "title": "Properties", "kind": 1024, - "children": [604, 608] + "children": [625, 629] } ], "sources": [ @@ -16026,14 +16880,14 @@ { "type": "reflection", "declaration": { - "id": 609, + "id": 630, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 610, + "id": 631, "name": "data", "kind": 1024, "kindString": "Property", @@ -16048,14 +16902,14 @@ "type": { "type": "reflection", "declaration": { - "id": 611, + "id": 632, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 612, + "id": 633, "name": "provider", "kind": 1024, "kindString": "Property", @@ -16069,12 +16923,12 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider" } }, { - "id": 613, + "id": 634, "name": "url", "kind": 1024, "kindString": "Property", @@ -16096,7 +16950,7 @@ { "title": "Properties", "kind": 1024, - "children": [612, 613] + "children": [633, 634] } ], "sources": [ @@ -16110,7 +16964,7 @@ } }, { - "id": 614, + "id": 635, "name": "error", "kind": 1024, "kindString": "Property", @@ -16124,7 +16978,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -16133,7 +16987,7 @@ { "title": "Properties", "kind": 1024, - "children": [610, 614] + "children": [631, 635] } ], "sources": [ @@ -16149,7 +17003,7 @@ } }, { - "id": 1048, + "id": 1069, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -16164,14 +17018,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1070, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1071, "name": "page", "kind": 1024, "kindString": "Property", @@ -16194,7 +17048,7 @@ } }, { - "id": 1051, + "id": 1072, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -16221,7 +17075,7 @@ { "title": "Properties", "kind": 1024, - "children": [1050, 1051] + "children": [1071, 1072] } ], "sources": [ @@ -16235,7 +17089,7 @@ } }, { - "id": 1041, + "id": 1062, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -16250,14 +17104,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1042, + "id": 1063, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1044, + "id": 1065, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -16275,7 +17129,7 @@ } }, { - "id": 1043, + "id": 1064, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -16302,7 +17156,7 @@ } }, { - "id": 1045, + "id": 1066, "name": "total", "kind": 1024, "kindString": "Property", @@ -16324,7 +17178,7 @@ { "title": "Properties", "kind": 1024, - "children": [1044, 1043, 1045] + "children": [1065, 1064, 1066] } ], "sources": [ @@ -16335,14 +17189,14 @@ } ], "indexSignature": { - "id": 1046, + "id": 1067, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1047, + "id": 1068, "name": "key", "kind": 32768, "flags": {}, @@ -16361,7 +17215,7 @@ } }, { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -16471,7 +17325,204 @@ } }, { - "id": 824, + "id": 1119, + "name": "RequiredClaims", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1209, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1120, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1127, + "name": "aal", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1216, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 981, + "name": "AuthenticatorAssuranceLevels" + } + }, + { + "id": 1123, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1212, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1124, + "name": "exp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1213, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1125, + "name": "iat", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1214, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1121, + "name": "iss", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1126, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1215, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1128, + "name": "session_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1217, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1122, + "name": "sub", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1211, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1127, 1123, 1124, 1125, 1121, 1126, 1128, 1122] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1209, + "character": 29 + } + ] + } + } + }, + { + "id": 845, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -16489,14 +17540,14 @@ { "type": "reflection", "declaration": { - "id": 825, + "id": 846, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 827, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", @@ -16514,7 +17565,7 @@ } }, { - "id": 828, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -16531,14 +17582,14 @@ "type": { "type": "reflection", "declaration": { - "id": 829, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 831, + "id": 852, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16561,7 +17612,7 @@ } }, { - "id": 830, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -16588,7 +17639,7 @@ { "title": "Properties", "kind": 1024, - "children": [831, 830] + "children": [852, 851] } ], "sources": [ @@ -16602,7 +17653,7 @@ } }, { - "id": 826, + "id": 847, "name": "type", "kind": 1024, "kindString": "Property", @@ -16619,7 +17670,7 @@ "typeArguments": [ { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType" }, { @@ -16646,7 +17697,7 @@ { "title": "Properties", "kind": 1024, - "children": [827, 828, 826] + "children": [848, 849, 847] } ], "sources": [ @@ -16661,14 +17712,14 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 853, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -16685,14 +17736,14 @@ "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 857, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 858, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16719,7 +17770,7 @@ { "title": "Properties", "kind": 1024, - "children": [837] + "children": [858] } ], "sources": [ @@ -16733,7 +17784,7 @@ } }, { - "id": 834, + "id": 855, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16751,7 +17802,7 @@ } }, { - "id": 833, + "id": 854, "name": "type", "kind": 1024, "kindString": "Property", @@ -16768,7 +17819,7 @@ "typeArguments": [ { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType" }, { @@ -16795,7 +17846,7 @@ { "title": "Properties", "kind": 1024, - "children": [835, 834, 833] + "children": [856, 855, 854] } ], "sources": [ @@ -16811,7 +17862,7 @@ } }, { - "id": 615, + "id": 636, "name": "SSOResponse", "kind": 4194304, "kindString": "Type alias", @@ -16829,14 +17880,14 @@ { "type": "reflection", "declaration": { - "id": 616, + "id": 637, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 638, "name": "data", "kind": 1024, "kindString": "Property", @@ -16851,14 +17902,14 @@ "type": { "type": "reflection", "declaration": { - "id": 618, + "id": 639, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 619, + "id": 640, "name": "url", "kind": 1024, "kindString": "Property", @@ -16884,7 +17935,7 @@ { "title": "Properties", "kind": 1024, - "children": [619] + "children": [640] } ], "sources": [ @@ -16898,7 +17949,7 @@ } }, { - "id": 620, + "id": 641, "name": "error", "kind": 1024, "kindString": "Property", @@ -16920,7 +17971,7 @@ { "title": "Properties", "kind": 1024, - "children": [617, 620] + "children": [638, 641] } ], "sources": [ @@ -16935,14 +17986,14 @@ { "type": "reflection", "declaration": { - "id": 621, + "id": 642, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 643, "name": "data", "kind": 1024, "kindString": "Property", @@ -16960,7 +18011,7 @@ } }, { - "id": 623, + "id": 644, "name": "error", "kind": 1024, "kindString": "Property", @@ -16974,7 +18025,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -16983,7 +18034,7 @@ { "title": "Properties", "kind": 1024, - "children": [622, 623] + "children": [643, 644] } ], "sources": [ @@ -16999,7 +18050,7 @@ } }, { - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17014,14 +18065,14 @@ "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 748, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 728, + "id": 749, "name": "options", "kind": 1024, "kindString": "Property", @@ -17038,14 +18089,14 @@ "type": { "type": "reflection", "declaration": { - "id": 729, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 752, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17068,7 +18119,7 @@ } }, { - "id": 730, + "id": 751, "name": "data", "kind": 1024, "kindString": "Property", @@ -17096,7 +18147,7 @@ { "title": "Properties", "kind": 1024, - "children": [731, 730] + "children": [752, 751] } ], "sources": [ @@ -17114,7 +18165,7 @@ { "title": "Properties", "kind": 1024, - "children": [728] + "children": [749] } ], "sources": [ @@ -17128,7 +18179,7 @@ } }, { - "id": 792, + "id": 813, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17143,14 +18194,14 @@ "type": { "type": "reflection", "declaration": { - "id": 793, + "id": 814, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -17173,7 +18224,7 @@ } }, { - "id": 798, + "id": 819, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -17196,7 +18247,7 @@ } }, { - "id": 799, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -17213,14 +18264,14 @@ "type": { "type": "reflection", "declaration": { - "id": 800, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 801, + "id": 822, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17247,7 +18298,7 @@ { "title": "Properties", "kind": 1024, - "children": [801] + "children": [822] } ], "sources": [ @@ -17261,7 +18312,7 @@ } }, { - "id": 794, + "id": 815, "name": "provider", "kind": 1024, "kindString": "Property", @@ -17309,7 +18360,7 @@ { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -17329,7 +18380,7 @@ } }, { - "id": 796, + "id": 817, "name": "token", "kind": 1024, "kindString": "Property", @@ -17354,7 +18405,7 @@ { "title": "Properties", "kind": 1024, - "children": [797, 798, 799, 794, 796] + "children": [818, 819, 820, 815, 817] } ], "sources": [ @@ -17368,7 +18419,7 @@ } }, { - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17383,14 +18434,14 @@ "type": { "type": "reflection", "declaration": { - "id": 781, + "id": 802, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 783, + "id": 804, "name": "options", "kind": 1024, "kindString": "Property", @@ -17407,14 +18458,14 @@ "type": { "type": "reflection", "declaration": { - "id": 784, + "id": 805, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 787, + "id": 808, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -17434,7 +18485,7 @@ "type": { "type": "reflection", "declaration": { - "id": 788, + "id": 809, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -17447,14 +18498,14 @@ } ], "indexSignature": { - "id": 789, + "id": 810, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 790, + "id": 811, "name": "key", "kind": 32768, "flags": {}, @@ -17473,7 +18524,7 @@ } }, { - "id": 785, + "id": 806, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17496,7 +18547,7 @@ } }, { - "id": 786, + "id": 807, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -17519,7 +18570,7 @@ } }, { - "id": 791, + "id": 812, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -17546,7 +18597,7 @@ { "title": "Properties", "kind": 1024, - "children": [787, 785, 786, 791] + "children": [808, 806, 807, 812] } ], "sources": [ @@ -17560,7 +18611,7 @@ } }, { - "id": 782, + "id": 803, "name": "provider", "kind": 1024, "kindString": "Property", @@ -17577,7 +18628,7 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider" } } @@ -17586,7 +18637,7 @@ { "title": "Properties", "kind": 1024, - "children": [783, 782] + "children": [804, 803] } ], "sources": [ @@ -17600,7 +18651,7 @@ } }, { - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17618,14 +18669,14 @@ { "type": "reflection", "declaration": { - "id": 750, + "id": 771, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 751, + "id": 772, "name": "email", "kind": 1024, "kindString": "Property", @@ -17646,7 +18697,7 @@ } }, { - "id": 753, + "id": 774, "name": "options", "kind": 1024, "kindString": "Property", @@ -17663,14 +18714,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 775, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 755, + "id": 776, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17697,7 +18748,7 @@ { "title": "Properties", "kind": 1024, - "children": [755] + "children": [776] } ], "sources": [ @@ -17711,7 +18762,7 @@ } }, { - "id": 752, + "id": 773, "name": "password", "kind": 1024, "kindString": "Property", @@ -17736,7 +18787,7 @@ { "title": "Properties", "kind": 1024, - "children": [751, 753, 752] + "children": [772, 774, 773] } ], "sources": [ @@ -17751,14 +18802,14 @@ { "type": "reflection", "declaration": { - "id": 756, + "id": 777, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 759, + "id": 780, "name": "options", "kind": 1024, "kindString": "Property", @@ -17775,14 +18826,14 @@ "type": { "type": "reflection", "declaration": { - "id": 760, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 782, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17809,7 +18860,7 @@ { "title": "Properties", "kind": 1024, - "children": [761] + "children": [782] } ], "sources": [ @@ -17823,7 +18874,7 @@ } }, { - "id": 758, + "id": 779, "name": "password", "kind": 1024, "kindString": "Property", @@ -17844,7 +18895,7 @@ } }, { - "id": 757, + "id": 778, "name": "phone", "kind": 1024, "kindString": "Property", @@ -17869,7 +18920,7 @@ { "title": "Properties", "kind": 1024, - "children": [759, 758, 757] + "children": [780, 779, 778] } ], "sources": [ @@ -17885,7 +18936,7 @@ } }, { - "id": 762, + "id": 783, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17903,14 +18954,14 @@ { "type": "reflection", "declaration": { - "id": 763, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 764, + "id": 785, "name": "email", "kind": 1024, "kindString": "Property", @@ -17931,7 +18982,7 @@ } }, { - "id": 765, + "id": 786, "name": "options", "kind": 1024, "kindString": "Property", @@ -17948,14 +18999,14 @@ "type": { "type": "reflection", "declaration": { - "id": 766, + "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 770, + "id": 791, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17978,7 +19029,7 @@ } }, { - "id": 769, + "id": 790, "name": "data", "kind": 1024, "kindString": "Property", @@ -18002,7 +19053,7 @@ } }, { - "id": 767, + "id": 788, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -18025,7 +19076,7 @@ } }, { - "id": 768, + "id": 789, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -18052,7 +19103,7 @@ { "title": "Properties", "kind": 1024, - "children": [770, 769, 767, 768] + "children": [791, 790, 788, 789] } ], "sources": [ @@ -18070,7 +19121,7 @@ { "title": "Properties", "kind": 1024, - "children": [764, 765] + "children": [785, 786] } ], "sources": [ @@ -18085,14 +19136,14 @@ { "type": "reflection", "declaration": { - "id": 771, + "id": 792, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 773, + "id": 794, "name": "options", "kind": 1024, "kindString": "Property", @@ -18109,14 +19160,14 @@ "type": { "type": "reflection", "declaration": { - "id": 774, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 777, + "id": 798, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18139,7 +19190,7 @@ } }, { - "id": 778, + "id": 799, "name": "channel", "kind": 1024, "kindString": "Property", @@ -18171,7 +19222,7 @@ } }, { - "id": 776, + "id": 797, "name": "data", "kind": 1024, "kindString": "Property", @@ -18195,7 +19246,7 @@ } }, { - "id": 775, + "id": 796, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -18222,7 +19273,7 @@ { "title": "Properties", "kind": 1024, - "children": [777, 778, 776, 775] + "children": [798, 799, 797, 796] } ], "sources": [ @@ -18236,7 +19287,7 @@ } }, { - "id": 772, + "id": 793, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18261,7 +19312,7 @@ { "title": "Properties", "kind": 1024, - "children": [773, 772] + "children": [794, 793] } ], "sources": [ @@ -18277,7 +19328,7 @@ } }, { - "id": 838, + "id": 859, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -18295,14 +19346,14 @@ { "type": "reflection", "declaration": { - "id": 839, + "id": 860, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 862, "name": "options", "kind": 1024, "kindString": "Property", @@ -18319,14 +19370,14 @@ "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18349,7 +19400,7 @@ } }, { - "id": 843, + "id": 864, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -18376,7 +19427,7 @@ { "title": "Properties", "kind": 1024, - "children": [844, 843] + "children": [865, 864] } ], "sources": [ @@ -18390,7 +19441,7 @@ } }, { - "id": 840, + "id": 861, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -18415,7 +19466,7 @@ { "title": "Properties", "kind": 1024, - "children": [841, 840] + "children": [862, 861] } ], "sources": [ @@ -18430,14 +19481,14 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 866, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 867, "name": "domain", "kind": 1024, "kindString": "Property", @@ -18458,7 +19509,7 @@ } }, { - "id": 847, + "id": 868, "name": "options", "kind": 1024, "kindString": "Property", @@ -18475,14 +19526,14 @@ "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 869, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 850, + "id": 871, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18505,7 +19556,7 @@ } }, { - "id": 849, + "id": 870, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -18532,7 +19583,7 @@ { "title": "Properties", "kind": 1024, - "children": [850, 849] + "children": [871, 870] } ], "sources": [ @@ -18550,7 +19601,7 @@ { "title": "Properties", "kind": 1024, - "children": [846, 847] + "children": [867, 868] } ], "sources": [ @@ -18566,7 +19617,7 @@ } }, { - "id": 1052, + "id": 1073, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -18581,14 +19632,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1053, + "id": 1074, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1054, + "id": 1075, "name": "scope", "kind": 1024, "kindString": "Property", @@ -18628,7 +19679,7 @@ { "title": "Properties", "kind": 1024, - "children": [1054] + "children": [1075] } ], "sources": [ @@ -18642,7 +19693,7 @@ } }, { - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -18660,14 +19711,14 @@ { "type": "reflection", "declaration": { - "id": 733, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 734, + "id": 755, "name": "email", "kind": 1024, "kindString": "Property", @@ -18688,7 +19739,7 @@ } }, { - "id": 736, + "id": 757, "name": "options", "kind": 1024, "kindString": "Property", @@ -18705,14 +19756,14 @@ "type": { "type": "reflection", "declaration": { - "id": 737, + "id": 758, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 740, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18735,7 +19786,7 @@ } }, { - "id": 739, + "id": 760, "name": "data", "kind": 1024, "kindString": "Property", @@ -18759,7 +19810,7 @@ } }, { - "id": 738, + "id": 759, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -18786,7 +19837,7 @@ { "title": "Properties", "kind": 1024, - "children": [740, 739, 738] + "children": [761, 760, 759] } ], "sources": [ @@ -18800,7 +19851,7 @@ } }, { - "id": 735, + "id": 756, "name": "password", "kind": 1024, "kindString": "Property", @@ -18825,7 +19876,7 @@ { "title": "Properties", "kind": 1024, - "children": [734, 736, 735] + "children": [755, 757, 756] } ], "sources": [ @@ -18840,14 +19891,14 @@ { "type": "reflection", "declaration": { - "id": 741, + "id": 762, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -18864,14 +19915,14 @@ "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 747, + "id": 768, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18894,7 +19945,7 @@ } }, { - "id": 748, + "id": 769, "name": "channel", "kind": 1024, "kindString": "Property", @@ -18926,7 +19977,7 @@ } }, { - "id": 746, + "id": 767, "name": "data", "kind": 1024, "kindString": "Property", @@ -18954,7 +20005,7 @@ { "title": "Properties", "kind": 1024, - "children": [747, 748, 746] + "children": [768, 769, 767] } ], "sources": [ @@ -18968,7 +20019,7 @@ } }, { - "id": 743, + "id": 764, "name": "password", "kind": 1024, "kindString": "Property", @@ -18989,7 +20040,7 @@ } }, { - "id": 742, + "id": 763, "name": "phone", "kind": 1024, "kindString": "Property", @@ -19014,7 +20065,7 @@ { "title": "Properties", "kind": 1024, - "children": [744, 743, 742] + "children": [765, 764, 763] } ], "sources": [ @@ -19030,7 +20081,7 @@ } }, { - "id": 1028, + "id": 1049, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -19085,14 +20136,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1050, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1030, + "id": 1051, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -19119,7 +20170,7 @@ { "title": "Properties", "kind": 1024, - "children": [1030] + "children": [1051] } ], "sources": [ @@ -19135,7 +20186,7 @@ } }, { - "id": 624, + "id": 645, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -19153,14 +20204,14 @@ { "type": "reflection", "declaration": { - "id": 625, + "id": 646, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 647, "name": "data", "kind": 1024, "kindString": "Property", @@ -19175,14 +20226,14 @@ "type": { "type": "reflection", "declaration": { - "id": 627, + "id": 648, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 628, + "id": 649, "name": "user", "kind": 1024, "kindString": "Property", @@ -19196,7 +20247,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -19205,7 +20256,7 @@ { "title": "Properties", "kind": 1024, - "children": [628] + "children": [649] } ], "sources": [ @@ -19219,7 +20270,7 @@ } }, { - "id": 629, + "id": 650, "name": "error", "kind": 1024, "kindString": "Property", @@ -19241,7 +20292,7 @@ { "title": "Properties", "kind": 1024, - "children": [626, 629] + "children": [647, 650] } ], "sources": [ @@ -19256,14 +20307,14 @@ { "type": "reflection", "declaration": { - "id": 630, + "id": 651, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 631, + "id": 652, "name": "data", "kind": 1024, "kindString": "Property", @@ -19278,14 +20329,14 @@ "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 653, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 633, + "id": 654, "name": "user", "kind": 1024, "kindString": "Property", @@ -19307,7 +20358,7 @@ { "title": "Properties", "kind": 1024, - "children": [633] + "children": [654] } ], "sources": [ @@ -19321,7 +20372,7 @@ } }, { - "id": 634, + "id": 655, "name": "error", "kind": 1024, "kindString": "Property", @@ -19335,7 +20386,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -19344,7 +20395,7 @@ { "title": "Properties", "kind": 1024, - "children": [631, 634] + "children": [652, 655] } ], "sources": [ @@ -19360,7 +20411,7 @@ } }, { - "id": 802, + "id": 823, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -19377,24 +20428,24 @@ "types": [ { "type": "reference", - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams" }, { "type": "reference", - "id": 819, + "id": 840, "name": "VerifyTokenHashParams" } ] } }, { - "id": 528, + "id": 549, "name": "WeakPassword", "kind": 4194304, "kindString": "Type alias", @@ -19409,14 +20460,14 @@ "type": { "type": "reflection", "declaration": { - "id": 529, + "id": 550, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 552, "name": "message", "kind": 1024, "kindString": "Property", @@ -19434,7 +20485,7 @@ } }, { - "id": 530, + "id": 551, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -19450,7 +20501,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 526, + "id": 547, "name": "WeakPasswordReasons" } } @@ -19460,7 +20511,7 @@ { "title": "Properties", "kind": 1024, - "children": [531, 530] + "children": [552, 551] } ], "sources": [ @@ -19474,7 +20525,7 @@ } }, { - "id": 526, + "id": 547, "name": "WeakPasswordReasons", "kind": 4194304, "kindString": "Type alias", @@ -19511,7 +20562,7 @@ { "type": "reflection", "declaration": { - "id": 527, + "id": 548, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -19531,7 +20582,7 @@ } }, { - "id": 475, + "id": 496, "name": "AuthAdminApi", "kind": 32, "kindString": "Variable", @@ -19556,7 +20607,7 @@ "defaultValue": "GoTrueAdminApi" }, { - "id": 476, + "id": 497, "name": "AuthClient", "kind": 32, "kindString": "Variable", @@ -19581,7 +20632,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 490, + "id": 511, "name": "lockInternals", "kind": 32, "kindString": "Variable", @@ -19606,14 +20657,14 @@ "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 512, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 492, + "id": 513, "name": "debug", "kind": 1024, "kindString": "Property", @@ -19644,7 +20695,7 @@ { "title": "Properties", "kind": 1024, - "children": [492] + "children": [513] } ] } @@ -19652,7 +20703,7 @@ "defaultValue": "..." }, { - "id": 1096, + "id": 1143, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -19666,14 +20717,14 @@ ], "signatures": [ { - "id": 1097, + "id": 1144, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1098, + "id": 1145, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19690,7 +20741,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1121, + "id": 1168, "name": "AuthApiError" } } @@ -19698,7 +20749,7 @@ ] }, { - "id": 1093, + "id": 1140, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -19712,14 +20763,14 @@ ], "signatures": [ { - "id": 1094, + "id": 1141, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1095, + "id": 1142, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19736,7 +20787,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -19744,7 +20795,7 @@ ] }, { - "id": 1102, + "id": 1149, "name": "isAuthImplicitGrantRedirectError", "kind": 64, "kindString": "Function", @@ -19758,14 +20809,14 @@ ], "signatures": [ { - "id": 1103, + "id": 1150, "name": "isAuthImplicitGrantRedirectError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1104, + "id": 1151, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19782,7 +20833,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1178, + "id": 1225, "name": "AuthImplicitGrantRedirectError" } } @@ -19790,7 +20841,7 @@ ] }, { - "id": 1105, + "id": 1152, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -19804,14 +20855,14 @@ ], "signatures": [ { - "id": 1106, + "id": 1153, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1107, + "id": 1154, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19828,7 +20879,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" } } @@ -19836,7 +20887,7 @@ ] }, { - "id": 1099, + "id": 1146, "name": "isAuthSessionMissingError", "kind": 64, "kindString": "Function", @@ -19850,14 +20901,14 @@ ], "signatures": [ { - "id": 1100, + "id": 1147, "name": "isAuthSessionMissingError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1101, + "id": 1148, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19874,7 +20925,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" } } @@ -19882,7 +20933,7 @@ ] }, { - "id": 1108, + "id": 1155, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -19896,14 +20947,14 @@ ], "signatures": [ { - "id": 1109, + "id": 1156, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1157, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19920,7 +20971,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" } } @@ -19928,7 +20979,7 @@ ] }, { - "id": 477, + "id": 498, "name": "navigatorLock", "kind": 64, "kindString": "Function", @@ -19942,7 +20993,7 @@ ], "signatures": [ { - "id": 478, + "id": 499, "name": "navigatorLock", "kind": 4096, "kindString": "Call signature", @@ -19953,7 +21004,7 @@ }, "typeParameter": [ { - "id": 479, + "id": 500, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -19962,7 +21013,7 @@ ], "parameters": [ { - "id": 480, + "id": 501, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -19976,7 +21027,7 @@ } }, { - "id": 481, + "id": 502, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -19990,7 +21041,7 @@ } }, { - "id": 482, + "id": 503, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -20001,14 +21052,14 @@ "type": { "type": "reflection", "declaration": { - "id": 483, + "id": 504, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 484, + "id": 505, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -20018,7 +21069,7 @@ "typeArguments": [ { "type": "reference", - "id": 479, + "id": 500, "name": "R" } ], @@ -20037,7 +21088,7 @@ "typeArguments": [ { "type": "reference", - "id": 479, + "id": 500, "name": "R" } ], @@ -20053,32 +21104,36 @@ { "title": "Classes", "kind": 128, - "children": [1121, 1111, 1178, 1169, 1161, 1205, 1232, 1153, 1131, 1242, 1141, 1, 78, 485] + "children": [ + 1168, 1158, 1225, 1216, 1301, 1208, 1252, 1279, 1200, 1178, 1289, 1188, 1, 78, 506 + ] }, { "title": "Interfaces", "kind": 256, - "children": [644, 705, 660, 873, 1021, 972, 635, 718, 675, 668, 699, 648, 672, 811, 803, 819] + "children": [ + 665, 726, 681, 894, 1042, 993, 1133, 656, 739, 696, 689, 720, 669, 693, 832, 824, 840 + ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 495, 494, 779, 1005, 996, 1018, 1009, 938, 1081, 928, 1065, 961, 949, 929, 915, 559, 532, - 545, 574, 587, 960, 1034, 823, 867, 857, 876, 890, 877, 897, 862, 851, 505, 1031, 496, 911, - 907, 898, 1060, 1055, 899, 902, 822, 602, 1048, 1041, 493, 824, 615, 726, 792, 780, 749, - 762, 838, 1052, 732, 1028, 624, 802, 528, 526 + 516, 515, 800, 1026, 1017, 1039, 1030, 959, 1102, 949, 1086, 982, 970, 950, 936, 580, 553, + 566, 595, 608, 981, 1055, 844, 888, 878, 897, 911, 898, 918, 883, 872, 526, 1052, 1114, + 1129, 517, 932, 928, 919, 1081, 1076, 920, 923, 843, 623, 1069, 1062, 514, 1119, 845, 636, + 747, 813, 801, 770, 783, 859, 1073, 753, 1049, 645, 823, 549, 547 ] }, { "title": "Variables", "kind": 32, - "children": [475, 476, 490] + "children": [496, 497, 511] }, { "title": "Functions", "kind": 64, - "children": [1096, 1093, 1102, 1105, 1099, 1108, 477] + "children": [1143, 1140, 1149, 1152, 1146, 1155, 498] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index a6f4145a128..56f9b0a4813 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 1121, + "id": 1168, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1122, + "id": 1169, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -28,14 +28,14 @@ ], "signatures": [ { - "id": 1123, + "id": 1170, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1124, + "id": 1171, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 1125, + "id": 1172, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -57,7 +57,7 @@ } }, { - "id": 1126, + "id": 1173, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -79,918 +79,22 @@ ], "type": { "type": "reference", - "id": 1121, + "id": 1168, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, - { - "id": 1128, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1129, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1117, - "name": "AuthError.code" - } - }, - { - "id": 1127, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "id": 1119, - "name": "AuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1122] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1128, 1127] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 30, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1111, - "name": "AuthError" - } - ] - }, - { - "id": 1111, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1112, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 18, - "character": 2 - } - ], - "signatures": [ - { - "id": 1113, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1114, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1115, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1116, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1111, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 1117, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 1119, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1112] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1117, 1119] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 1121, - "name": "AuthApiError" - }, - { - "type": "reference", - "id": 1131, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 1141, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1178, - "name": "AuthImplicitGrantRedirectError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1179, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 2 - } - ], - "signatures": [ - { - "id": 1180, - "name": "new AuthImplicitGrantRedirectError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1181, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1185, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1184, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1185, 1184] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 1178, - "name": "AuthImplicitGrantRedirectError" - }, - "overwrites": { - "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1202, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "name": "ErrorCode" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1203, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1150, - "name": "CustomAuthError.code" - } - }, - { - "id": 1186, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1189, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1188, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1189, 1188] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1200, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1148, - "name": "CustomAuthError.name" - } - }, - { - "id": 1201, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1149, - "name": "CustomAuthError.status" - } - }, - { - "id": 1190, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 2 - } - ], - "signatures": [ - { - "id": 1191, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1196, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1197, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1199, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1198, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1199, 1198] - } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 1194, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 98, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1193, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1195, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1196, 1194, 1193, 1195] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1179] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1202, 1186, 1200, 1201] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1190] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 88, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1141, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1169, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1170, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 83, - "character": 2 - } - ], - "signatures": [ - { - "id": 1171, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1172, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1169, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" - } - }, { "id": 1175, "name": "code", @@ -1014,10 +118,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -1036,36 +136,17 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, - "name": "CustomAuthError.code" - } - }, - { - "id": 1173, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1148, - "name": "CustomAuthError.name" + "id": 1164, + "name": "AuthError.code" } }, { @@ -1080,7 +161,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 57, + "line": 31, "character": 2 } ], @@ -1088,10 +169,10 @@ "type": "intrinsic", "name": "number" }, - "inheritedFrom": { + "overwrites": { "type": "reference", - "id": 1149, - "name": "CustomAuthError.status" + "id": 1166, + "name": "AuthError.status" } } ], @@ -1099,38 +180,38 @@ { "title": "Constructors", "kind": 512, - "children": [1170] + "children": [1169] }, { "title": "Properties", "kind": 1024, - "children": [1175, 1173, 1174] + "children": [1175, 1174] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 82, + "line": 30, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1141, - "name": "CustomAuthError" + "id": 1158, + "name": "AuthError" } ] }, { - "id": 1161, - "name": "AuthInvalidTokenResponseError", + "id": 1158, + "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1162, + "id": 1159, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1138,37 +219,74 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 77, + "line": 18, "character": 2 } ], "signatures": [ { - "id": 1163, - "name": "new AuthInvalidTokenResponseError", + "id": 1160, + "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, + "parameters": [ + { + "id": 1161, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1162, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1163, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "type": { "type": "reference", - "id": 1161, - "name": "AuthInvalidTokenResponseError" + "id": 1158, + "name": "AuthError" }, "overwrites": { "type": "reference", - "id": 1143, - "name": "CustomAuthError.constructor" + "name": "Error.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, - "name": "CustomAuthError.constructor" + "name": "Error.constructor" } }, { - "id": 1166, + "id": 1164, "name": "code", "kind": 1024, "kindString": "Property", @@ -1190,9 +308,260 @@ "type": "intrinsic", "name": "undefined" }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1165, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, { "type": "reference", "name": "ErrorCode" + } + ] + } + }, + { + "id": 1166, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1159] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1164, 1166] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 1168, + "name": "AuthApiError" + }, + { + "type": "reference", + "id": 1178, + "name": "AuthUnknownError" + }, + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1225, + "name": "AuthImplicitGrantRedirectError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1226, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 2 + } + ], + "signatures": [ + { + "id": 1227, + "name": "new AuthImplicitGrantRedirectError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1228, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1229, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1230, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1232, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1231, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1232, 1231] + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 1225, + "name": "AuthImplicitGrantRedirectError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1249, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" }, { "type": "intersection", @@ -1204,7 +573,7 @@ { "type": "reflection", "declaration": { - "id": 1167, + "id": 1250, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1212,17 +581,100 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1164, + "id": 1233, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1234, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1236, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1235, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1236, 1235] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 1247, "name": "name", "kind": 1024, "kindString": "Property", @@ -1240,12 +692,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1165, + "id": 1248, "name": "status", "kind": 1024, "kindString": "Property", @@ -1266,7 +718,379 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, + "name": "CustomAuthError.status" + } + }, + { + "id": 1237, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 95, + "character": 2 + } + ], + "signatures": [ + { + "id": 1238, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1239, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1243, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 100, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1244, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1246, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1245, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1246, 1245] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 1241, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 98, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1240, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 97, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1242, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 99, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1243, 1241, 1240, 1242] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1226] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1249, 1233, 1247, 1248] + }, + { + "title": "Methods", + "kind": 2048, + "children": [1237] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 88, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1216, + "name": "AuthInvalidCredentialsError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1217, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 83, + "character": 2 + } + ], + "signatures": [ + { + "id": 1218, + "name": "new AuthInvalidCredentialsError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1219, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1216, + "name": "AuthInvalidCredentialsError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1222, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1223, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1220, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1221, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, "name": "CustomAuthError.status" } } @@ -1275,12 +1099,377 @@ { "title": "Constructors", "kind": 512, - "children": [1162] + "children": [1217] }, { "title": "Properties", "kind": 1024, - "children": [1166, 1164, 1165] + "children": [1222, 1220, 1221] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 82, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1301, + "name": "AuthInvalidJwtError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1302, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 162, + "character": 2 + } + ], + "signatures": [ + { + "id": 1303, + "name": "new AuthInvalidJwtError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1304, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1301, + "name": "AuthInvalidJwtError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1307, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1308, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1305, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1306, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1302] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1307, 1305, 1306] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 161, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1188, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1208, + "name": "AuthInvalidTokenResponseError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1209, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 2 + } + ], + "signatures": [ + { + "id": 1210, + "name": "new AuthInvalidTokenResponseError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 1208, + "name": "AuthInvalidTokenResponseError" + }, + "overwrites": { + "type": "reference", + "id": 1190, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1189, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1213, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1214, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1197, + "name": "CustomAuthError.code" + } + }, + { + "id": 1211, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1195, + "name": "CustomAuthError.name" + } + }, + { + "id": 1212, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1196, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1209] + }, + { + "title": "Properties", + "kind": 1024, + "children": [1213, 1211, 1212] } ], "sources": [ @@ -1293,20 +1482,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1206, + "id": 1253, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1320,14 +1509,14 @@ ], "signatures": [ { - "id": 1207, + "id": 1254, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1208, + "id": 1255, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1338,7 +1527,7 @@ } }, { - "id": 1209, + "id": 1256, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -1353,14 +1542,14 @@ { "type": "reflection", "declaration": { - "id": 1210, + "id": 1257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1212, + "id": 1259, "name": "code", "kind": 1024, "kindString": "Property", @@ -1378,7 +1567,7 @@ } }, { - "id": 1211, + "id": 1258, "name": "error", "kind": 1024, "kindString": "Property", @@ -1400,7 +1589,7 @@ { "title": "Properties", "kind": 1024, - "children": [1212, 1211] + "children": [1259, 1258] } ] } @@ -1412,24 +1601,24 @@ ], "type": { "type": "reference", - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1229, + "id": 1276, "name": "code", "kind": 1024, "kindString": "Property", @@ -1451,10 +1640,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -1465,7 +1650,7 @@ { "type": "reflection", "declaration": { - "id": 1230, + "id": 1277, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1473,17 +1658,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1213, + "id": 1260, "name": "details", "kind": 1024, "kindString": "Property", @@ -1505,14 +1694,14 @@ { "type": "reflection", "declaration": { - "id": 1214, + "id": 1261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1216, + "id": 1263, "name": "code", "kind": 1024, "kindString": "Property", @@ -1530,7 +1719,7 @@ } }, { - "id": 1215, + "id": 1262, "name": "error", "kind": 1024, "kindString": "Property", @@ -1552,7 +1741,7 @@ { "title": "Properties", "kind": 1024, - "children": [1216, 1215] + "children": [1263, 1262] } ] } @@ -1562,7 +1751,7 @@ "defaultValue": "null" }, { - "id": 1227, + "id": 1274, "name": "name", "kind": 1024, "kindString": "Property", @@ -1580,12 +1769,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1228, + "id": 1275, "name": "status", "kind": 1024, "kindString": "Property", @@ -1606,12 +1795,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } }, { - "id": 1217, + "id": 1264, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1625,7 +1814,7 @@ ], "signatures": [ { - "id": 1218, + "id": 1265, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1633,14 +1822,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1219, + "id": 1266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1223, + "id": 1270, "name": "details", "kind": 1024, "kindString": "Property", @@ -1662,14 +1851,14 @@ { "type": "reflection", "declaration": { - "id": 1224, + "id": 1271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1226, + "id": 1273, "name": "code", "kind": 1024, "kindString": "Property", @@ -1687,7 +1876,7 @@ } }, { - "id": 1225, + "id": 1272, "name": "error", "kind": 1024, "kindString": "Property", @@ -1709,7 +1898,7 @@ { "title": "Properties", "kind": 1024, - "children": [1226, 1225] + "children": [1273, 1272] } ] } @@ -1719,7 +1908,7 @@ "defaultValue": "..." }, { - "id": 1221, + "id": 1268, "name": "message", "kind": 1024, "kindString": "Property", @@ -1738,7 +1927,7 @@ "defaultValue": "..." }, { - "id": 1220, + "id": 1267, "name": "name", "kind": 1024, "kindString": "Property", @@ -1757,7 +1946,7 @@ "defaultValue": "..." }, { - "id": 1222, + "id": 1269, "name": "status", "kind": 1024, "kindString": "Property", @@ -1780,7 +1969,7 @@ { "title": "Properties", "kind": 1024, - "children": [1223, 1221, 1220, 1222] + "children": [1270, 1268, 1267, 1269] } ] } @@ -1793,17 +1982,17 @@ { "title": "Constructors", "kind": 512, - "children": [1206] + "children": [1253] }, { "title": "Properties", "kind": 1024, - "children": [1229, 1213, 1227, 1228] + "children": [1276, 1260, 1274, 1275] }, { "title": "Methods", "kind": 2048, - "children": [1217] + "children": [1264] } ], "sources": [ @@ -1816,20 +2005,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1233, + "id": 1280, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1843,14 +2032,14 @@ ], "signatures": [ { - "id": 1234, + "id": 1281, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1235, + "id": 1282, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1861,7 +2050,7 @@ } }, { - "id": 1236, + "id": 1283, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1874,24 +2063,24 @@ ], "type": { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1239, + "id": 1286, "name": "code", "kind": 1024, "kindString": "Property", @@ -1913,10 +2102,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -1927,7 +2112,7 @@ { "type": "reflection", "declaration": { - "id": 1240, + "id": 1287, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1935,17 +2120,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1237, + "id": 1284, "name": "name", "kind": 1024, "kindString": "Property", @@ -1963,12 +2152,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1238, + "id": 1285, "name": "status", "kind": 1024, "kindString": "Property", @@ -1989,7 +2178,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -1998,12 +2187,12 @@ { "title": "Constructors", "kind": 512, - "children": [1233] + "children": [1280] }, { "title": "Properties", "kind": 1024, - "children": [1239, 1237, 1238] + "children": [1286, 1284, 1285] } ], "sources": [ @@ -2016,20 +2205,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1154, + "id": 1201, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2043,31 +2232,31 @@ ], "signatures": [ { - "id": 1155, + "id": 1202, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1158, + "id": 1205, "name": "code", "kind": 1024, "kindString": "Property", @@ -2089,10 +2278,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2103,7 +2288,7 @@ { "type": "reflection", "declaration": { - "id": 1159, + "id": 1206, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2111,17 +2296,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1156, + "id": 1203, "name": "name", "kind": 1024, "kindString": "Property", @@ -2139,12 +2328,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1157, + "id": 1204, "name": "status", "kind": 1024, "kindString": "Property", @@ -2165,7 +2354,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -2174,12 +2363,12 @@ { "title": "Constructors", "kind": 512, - "children": [1154] + "children": [1201] }, { "title": "Properties", "kind": 1024, - "children": [1158, 1156, 1157] + "children": [1205, 1203, 1204] } ], "sources": [ @@ -2192,20 +2381,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1131, + "id": 1178, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1132, + "id": 1179, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2219,14 +2408,14 @@ ], "signatures": [ { - "id": 1133, + "id": 1180, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1134, + "id": 1181, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2237,7 +2426,7 @@ } }, { - "id": 1135, + "id": 1182, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2250,24 +2439,24 @@ ], "type": { "type": "reference", - "id": 1131, + "id": 1178, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, { - "id": 1137, + "id": 1184, "name": "code", "kind": 1024, "kindString": "Property", @@ -2289,10 +2478,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2303,7 +2488,7 @@ { "type": "reflection", "declaration": { - "id": 1138, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2311,17 +2496,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1117, + "id": 1164, "name": "AuthError.code" } }, { - "id": 1136, + "id": 1183, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2339,7 +2528,7 @@ } }, { - "id": 1139, + "id": 1186, "name": "status", "kind": 1024, "kindString": "Property", @@ -2369,7 +2558,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1119, + "id": 1166, "name": "AuthError.status" } } @@ -2378,12 +2567,12 @@ { "title": "Constructors", "kind": 512, - "children": [1132] + "children": [1179] }, { "title": "Properties", "kind": 1024, - "children": [1137, 1136, 1139] + "children": [1184, 1183, 1186] } ], "sources": [ @@ -2396,13 +2585,13 @@ "extendedTypes": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] }, { - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", @@ -2412,7 +2601,7 @@ }, "children": [ { - "id": 1243, + "id": 1290, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2426,14 +2615,14 @@ ], "signatures": [ { - "id": 1244, + "id": 1291, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1245, + "id": 1292, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2444,7 +2633,7 @@ } }, { - "id": 1246, + "id": 1293, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2455,7 +2644,7 @@ } }, { - "id": 1247, + "id": 1294, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -2471,24 +2660,24 @@ ], "type": { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1143, + "id": 1190, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1142, + "id": 1189, "name": "CustomAuthError.constructor" } }, { - "id": 1251, + "id": 1298, "name": "code", "kind": 1024, "kindString": "Property", @@ -2510,10 +2699,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2524,7 +2709,7 @@ { "type": "reflection", "declaration": { - "id": 1252, + "id": 1299, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2532,17 +2717,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1150, + "id": 1197, "name": "CustomAuthError.code" } }, { - "id": 1249, + "id": 1296, "name": "name", "kind": 1024, "kindString": "Property", @@ -2560,12 +2749,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1148, + "id": 1195, "name": "CustomAuthError.name" } }, { - "id": 1248, + "id": 1295, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -2584,13 +2773,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 526, + "id": 547, "name": "WeakPasswordReasons" } } }, { - "id": 1250, + "id": 1297, "name": "status", "kind": 1024, "kindString": "Property", @@ -2611,7 +2800,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1149, + "id": 1196, "name": "CustomAuthError.status" } } @@ -2620,12 +2809,12 @@ { "title": "Constructors", "kind": 512, - "children": [1243] + "children": [1290] }, { "title": "Properties", "kind": 1024, - "children": [1251, 1249, 1248, 1250] + "children": [1298, 1296, 1295, 1297] } ], "sources": [ @@ -2638,20 +2827,20 @@ "extendedTypes": [ { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" } ] }, { - "id": 1141, + "id": 1188, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1142, + "id": 1189, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2665,14 +2854,14 @@ ], "signatures": [ { - "id": 1143, + "id": 1190, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1144, + "id": 1191, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2683,7 +2872,7 @@ } }, { - "id": 1145, + "id": 1192, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2694,7 +2883,7 @@ } }, { - "id": 1146, + "id": 1193, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2705,7 +2894,7 @@ } }, { - "id": 1147, + "id": 1194, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -2727,24 +2916,24 @@ ], "type": { "type": "reference", - "id": 1141, + "id": 1188, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1113, + "id": 1160, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1112, + "id": 1159, "name": "AuthError.constructor" } }, { - "id": 1150, + "id": 1197, "name": "code", "kind": 1024, "kindString": "Property", @@ -2766,10 +2955,6 @@ "type": "intrinsic", "name": "undefined" }, - { - "type": "reference", - "name": "ErrorCode" - }, { "type": "intersection", "types": [ @@ -2780,7 +2965,7 @@ { "type": "reflection", "declaration": { - "id": 1151, + "id": 1198, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2788,17 +2973,21 @@ } } ] + }, + { + "type": "reference", + "name": "ErrorCode" } ] }, "inheritedFrom": { "type": "reference", - "id": 1117, + "id": 1164, "name": "AuthError.code" } }, { - "id": 1148, + "id": 1195, "name": "name", "kind": 1024, "kindString": "Property", @@ -2820,7 +3009,7 @@ } }, { - "id": 1149, + "id": 1196, "name": "status", "kind": 1024, "kindString": "Property", @@ -2841,7 +3030,7 @@ }, "overwrites": { "type": "reference", - "id": 1119, + "id": 1166, "name": "AuthError.status" } } @@ -2850,12 +3039,12 @@ { "title": "Constructors", "kind": 512, - "children": [1142] + "children": [1189] }, { "title": "Properties", "kind": 1024, - "children": [1150, 1148, 1149] + "children": [1197, 1195, 1196] } ], "sources": [ @@ -2868,45 +3057,50 @@ "extendedTypes": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1161, + "id": 1208, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1169, + "id": 1216, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1178, + "id": 1225, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1205, + "id": 1252, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" + }, + { + "type": "reference", + "id": 1301, + "name": "AuthInvalidJwtError" } ] }, @@ -3148,10 +3342,10 @@ ], "type": { "type": "reference", - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -3167,14 +3361,14 @@ }, "children": [ { - "id": 1025, + "id": 1046, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1026, + "id": 1047, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -3194,17 +3388,17 @@ }, "parameters": [ { - "id": 1027, + "id": 1048, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -3227,14 +3421,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -3255,7 +3449,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -3280,7 +3474,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -3301,7 +3495,7 @@ "typeArguments": [ { "type": "reference", - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -3313,14 +3507,14 @@ ] }, { - "id": 1022, + "id": 1043, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1023, + "id": 1044, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -3330,17 +3524,17 @@ }, "parameters": [ { - "id": 1024, + "id": 1045, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -3363,14 +3557,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -3395,7 +3589,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -3416,7 +3610,7 @@ "typeArguments": [ { "type": "reference", - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -3432,7 +3626,7 @@ { "title": "Methods", "kind": 2048, - "children": [1025, 1022] + "children": [1046, 1043] } ], "sources": [ @@ -3477,17 +3671,17 @@ "flags": {}, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -3511,7 +3705,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -3535,7 +3729,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -3562,7 +3756,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -3586,7 +3780,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -3610,7 +3804,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -3638,7 +3832,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -3665,7 +3859,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -3689,7 +3883,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -3716,7 +3910,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -3740,7 +3934,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -3764,7 +3958,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -3792,7 +3986,7 @@ { "title": "Properties", "kind": 1024, - "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] + "children": [728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727] } ], "sources": [ @@ -3808,7 +4002,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -3830,7 +4024,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -3900,7 +4094,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -3943,10 +4137,10 @@ "flags": {}, "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkParams", "dereferenced": { - "id": 876, + "id": 897, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -3962,7 +4156,7 @@ "type": "union", "types": [ { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -3977,14 +4171,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -4002,7 +4196,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -4021,7 +4215,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -4044,7 +4238,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -4062,7 +4256,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -4084,7 +4278,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -4098,7 +4292,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4113,14 +4307,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -4141,7 +4335,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -4160,7 +4354,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -4183,7 +4377,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -4214,7 +4408,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -4228,7 +4422,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4243,14 +4437,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -4271,7 +4465,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -4290,7 +4484,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -4304,7 +4498,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -4326,7 +4520,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -4340,7 +4534,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4355,14 +4549,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -4383,7 +4577,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -4404,7 +4598,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -4423,7 +4617,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -4437,7 +4631,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -4468,7 +4662,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -4492,7 +4686,7 @@ "typeArguments": [ { "type": "reference", - "id": 877, + "id": 898, "name": "GenerateLinkResponse" } ], @@ -4547,7 +4741,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -4678,7 +4872,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -4727,10 +4921,10 @@ }, "type": { "type": "reference", - "id": 1048, + "id": 1069, "name": "PageParams", "dereferenced": { - "id": 1048, + "id": 1069, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -4745,14 +4939,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1070, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1071, "name": "page", "kind": 1024, "kindString": "Property", @@ -4775,7 +4969,7 @@ } }, { - "id": 1051, + "id": 1072, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -4802,7 +4996,7 @@ { "title": "Properties", "kind": 1024, - "children": [1050, 1051] + "children": [1071, 1072] } ], "sources": [ @@ -4893,7 +5087,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -4910,7 +5104,7 @@ }, { "type": "reference", - "id": 1041, + "id": 1062, "name": "Pagination" } ] @@ -5018,7 +5212,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -5161,7 +5355,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -5231,17 +5425,17 @@ }, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -5265,7 +5459,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -5289,7 +5483,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -5316,7 +5510,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -5340,7 +5534,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -5364,7 +5558,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -5392,7 +5586,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -5419,7 +5613,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -5443,7 +5637,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -5470,7 +5664,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -5494,7 +5688,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -5518,7 +5712,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -5546,7 +5740,7 @@ { "title": "Properties", "kind": 1024, - "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] + "children": [728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727] } ], "sources": [ @@ -5562,7 +5756,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -5584,7 +5778,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -5637,7 +5831,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 182, + "line": 191, "character": 2 } ], @@ -5660,10 +5854,10 @@ "flags": {}, "type": { "type": "reference", - "id": 505, + "id": 526, "name": "GoTrueClientOptions", "dereferenced": { - "id": 505, + "id": 526, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -5678,14 +5872,14 @@ "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 535, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -5705,7 +5899,7 @@ } }, { - "id": 519, + "id": 540, "name": "debug", "kind": 1024, "kindString": "Property", @@ -5729,7 +5923,7 @@ { "type": "reflection", "declaration": { - "id": 520, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5743,14 +5937,14 @@ ], "signatures": [ { - "id": 521, + "id": 542, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 522, + "id": 543, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -5761,7 +5955,7 @@ } }, { - "id": 523, + "id": 544, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -5789,7 +5983,7 @@ } }, { - "id": 513, + "id": 534, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -5809,7 +6003,7 @@ } }, { - "id": 517, + "id": 538, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -5829,7 +6023,7 @@ } }, { - "id": 518, + "id": 539, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -5845,10 +6039,10 @@ ], "type": { "type": "reference", - "id": 779, + "id": 800, "name": "AuthFlowType", "dereferenced": { - "id": 779, + "id": 800, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -5877,7 +6071,7 @@ } }, { - "id": 525, + "id": 546, "name": "hasCustomAuthorizationHeader", "kind": 1024, "kindString": "Property", @@ -5906,7 +6100,7 @@ } }, { - "id": 508, + "id": 529, "name": "headers", "kind": 1024, "kindString": "Property", @@ -5923,7 +6117,7 @@ "type": { "type": "reflection", "declaration": { - "id": 509, + "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5936,14 +6130,14 @@ } ], "indexSignature": { - "id": 510, + "id": 531, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 511, + "id": 532, "name": "key", "kind": 32768, "flags": {}, @@ -5962,7 +6156,7 @@ } }, { - "id": 524, + "id": 545, "name": "lock", "kind": 1024, "kindString": "Property", @@ -5987,10 +6181,10 @@ ], "type": { "type": "reference", - "id": 496, + "id": 517, "name": "LockFunc", "dereferenced": { - "id": 496, + "id": 517, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -6005,7 +6199,7 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6019,7 +6213,7 @@ ], "signatures": [ { - "id": 498, + "id": 519, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -6035,7 +6229,7 @@ }, "typeParameter": [ { - "id": 504, + "id": 525, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -6044,7 +6238,7 @@ ], "parameters": [ { - "id": 499, + "id": 520, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -6058,7 +6252,7 @@ } }, { - "id": 500, + "id": 521, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -6072,7 +6266,7 @@ } }, { - "id": 501, + "id": 522, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -6083,7 +6277,7 @@ "type": { "type": "reflection", "declaration": { - "id": 502, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6097,7 +6291,7 @@ ], "signatures": [ { - "id": 503, + "id": 524, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -6107,7 +6301,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -6126,7 +6320,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -6142,7 +6336,7 @@ } }, { - "id": 515, + "id": 536, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -6162,7 +6356,7 @@ } }, { - "id": 516, + "id": 537, "name": "storage", "kind": 1024, "kindString": "Property", @@ -6178,10 +6372,10 @@ ], "type": { "type": "reference", - "id": 1028, + "id": 1049, "name": "SupportedStorage", "dereferenced": { - "id": 1028, + "id": 1049, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -6236,14 +6430,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1050, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1030, + "id": 1051, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -6270,7 +6464,7 @@ { "title": "Properties", "kind": 1024, - "children": [1030] + "children": [1051] } ], "sources": [ @@ -6288,7 +6482,7 @@ } }, { - "id": 512, + "id": 533, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -6308,7 +6502,7 @@ } }, { - "id": 507, + "id": 528, "name": "url", "kind": 1024, "kindString": "Property", @@ -6333,7 +6527,7 @@ "title": "Properties", "kind": 1024, "children": [ - 514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507 + 535, 540, 534, 538, 539, 546, 529, 545, 536, 537, 533, 528 ] } ], @@ -6370,7 +6564,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 132, + "line": 138, "character": 2 } ], @@ -6616,10 +6810,10 @@ ], "type": { "type": "reference", - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -6635,14 +6829,14 @@ }, "children": [ { - "id": 1025, + "id": 1046, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1026, + "id": 1047, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -6662,17 +6856,17 @@ }, "parameters": [ { - "id": 1027, + "id": 1048, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -6695,14 +6889,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -6723,7 +6917,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -6748,7 +6942,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -6769,7 +6963,7 @@ "typeArguments": [ { "type": "reference", - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -6781,14 +6975,14 @@ ] }, { - "id": 1022, + "id": 1043, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1023, + "id": 1044, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -6798,17 +6992,17 @@ }, "parameters": [ { - "id": 1024, + "id": 1045, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -6831,14 +7025,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -6863,7 +7057,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -6884,7 +7078,7 @@ "typeArguments": [ { "type": "reference", - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -6900,7 +7094,7 @@ { "title": "Methods", "kind": 2048, - "children": [1025, 1022] + "children": [1046, 1043] } ], "sources": [ @@ -6945,17 +7139,17 @@ "flags": {}, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -6979,7 +7173,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -7003,7 +7197,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -7030,7 +7224,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -7054,7 +7248,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -7078,7 +7272,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -7106,7 +7300,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -7133,7 +7327,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -7157,7 +7351,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -7184,7 +7378,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -7208,7 +7402,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -7232,7 +7426,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -7261,7 +7455,7 @@ "title": "Properties", "kind": 1024, "children": [ - 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + 728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727 ] } ], @@ -7278,7 +7472,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -7300,7 +7494,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -7370,7 +7564,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -7413,10 +7607,10 @@ "flags": {}, "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkParams", "dereferenced": { - "id": 876, + "id": 897, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7432,7 +7626,7 @@ "type": "union", "types": [ { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7447,14 +7641,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -7472,7 +7666,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -7491,7 +7685,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -7514,7 +7708,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -7532,7 +7726,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -7554,7 +7748,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -7568,7 +7762,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7583,14 +7777,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -7611,7 +7805,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -7630,7 +7824,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -7653,7 +7847,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -7684,7 +7878,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -7698,7 +7892,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7713,14 +7907,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -7741,7 +7935,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -7760,7 +7954,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -7774,7 +7968,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -7796,7 +7990,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -7810,7 +8004,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7825,14 +8019,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -7853,7 +8047,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -7874,7 +8068,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -7893,7 +8087,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -7907,7 +8101,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -7938,7 +8132,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -7962,7 +8156,7 @@ "typeArguments": [ { "type": "reference", - "id": 877, + "id": 898, "name": "GenerateLinkResponse" } ], @@ -8017,7 +8211,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -8148,7 +8342,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -8197,10 +8391,10 @@ }, "type": { "type": "reference", - "id": 1048, + "id": 1069, "name": "PageParams", "dereferenced": { - "id": 1048, + "id": 1069, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -8215,14 +8409,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1070, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1071, "name": "page", "kind": 1024, "kindString": "Property", @@ -8245,7 +8439,7 @@ } }, { - "id": 1051, + "id": 1072, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -8272,7 +8466,7 @@ { "title": "Properties", "kind": 1024, - "children": [1050, 1051] + "children": [1071, 1072] } ], "sources": [ @@ -8363,7 +8557,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -8380,7 +8574,7 @@ }, { "type": "reference", - "id": 1041, + "id": 1062, "name": "Pagination" } ] @@ -8488,7 +8682,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -8631,7 +8825,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -8701,17 +8895,17 @@ }, "type": { "type": "reference", - "id": 705, + "id": 726, "name": "AdminUserAttributes", "dereferenced": { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -8735,7 +8929,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -8759,7 +8953,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -8786,7 +8980,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -8810,7 +9004,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -8834,7 +9028,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -8862,7 +9056,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -8889,7 +9083,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -8913,7 +9107,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -8940,7 +9134,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -8964,7 +9158,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -8988,7 +9182,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -9017,7 +9211,7 @@ "title": "Properties", "kind": 1024, "children": [ - 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + 728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727 ] } ], @@ -9034,7 +9228,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -9056,7 +9250,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -9107,16 +9301,16 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 136, + "line": 142, "character": 2 } ], "type": { "type": "reference", - "id": 972, + "id": 993, "name": "GoTrueMFAApi", "dereferenced": { - "id": 972, + "id": 993, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -9126,14 +9320,14 @@ }, "children": [ { - "id": 980, + "id": 1001, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 1002, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -9143,17 +9337,17 @@ }, "parameters": [ { - "id": 982, + "id": 1003, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 907, + "id": 928, "name": "MFAChallengeParams", "dereferenced": { - "id": 907, + "id": 928, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -9168,14 +9362,14 @@ "type": { "type": "reflection", "declaration": { - "id": 908, + "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 910, + "id": 931, "name": "channel", "kind": 1024, "kindString": "Property", @@ -9207,7 +9401,7 @@ } }, { - "id": 909, + "id": 930, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -9232,7 +9426,7 @@ { "title": "Properties", "kind": 1024, - "children": [910, 909] + "children": [931, 930] } ], "sources": [ @@ -9253,7 +9447,7 @@ "typeArguments": [ { "type": "reference", - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse" } ], @@ -9265,14 +9459,14 @@ ] }, { - "id": 989, + "id": 1010, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 990, + "id": 1011, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -9282,17 +9476,17 @@ }, "parameters": [ { - "id": 991, + "id": 1012, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -9307,14 +9501,14 @@ "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 933, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 914, + "id": 935, "name": "code", "kind": 1024, "kindString": "Property", @@ -9335,7 +9529,7 @@ } }, { - "id": 913, + "id": 934, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -9360,7 +9554,7 @@ { "title": "Properties", "kind": 1024, - "children": [914, 913] + "children": [935, 934] } ], "sources": [ @@ -9381,7 +9575,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -9393,14 +9587,14 @@ ] }, { - "id": 973, + "id": 994, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 974, + "id": 995, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -9411,17 +9605,17 @@ }, "parameters": [ { - "id": 975, + "id": 996, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -9436,14 +9630,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -9464,7 +9658,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -9487,7 +9681,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -9514,7 +9708,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -9535,7 +9729,7 @@ "typeArguments": [ { "type": "reference", - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse" } ], @@ -9545,24 +9739,24 @@ } }, { - "id": 976, + "id": 997, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 977, + "id": 998, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -9577,14 +9771,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -9605,7 +9799,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -9628,7 +9822,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -9653,7 +9847,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -9674,7 +9868,7 @@ "typeArguments": [ { "type": "reference", - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse" } ], @@ -9684,24 +9878,24 @@ } }, { - "id": 978, + "id": 999, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 979, + "id": 1000, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 898, + "id": 919, "name": "MFAEnrollParams", "dereferenced": { - "id": 898, + "id": 919, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -9717,7 +9911,7 @@ "type": "union", "types": [ { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -9732,14 +9926,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -9760,7 +9954,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -9783,7 +9977,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -9810,7 +10004,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -9824,7 +10018,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -9839,14 +10033,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -9867,7 +10061,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -9890,7 +10084,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -9915,7 +10109,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -9939,7 +10133,7 @@ "typeArguments": [ { "type": "reference", - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse" } ], @@ -9951,14 +10145,14 @@ ] }, { - "id": 994, + "id": 1015, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 995, + "id": 1016, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -9972,7 +10166,7 @@ "typeArguments": [ { "type": "reference", - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -9984,14 +10178,14 @@ ] }, { - "id": 992, + "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 993, + "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -10018,7 +10212,7 @@ "typeArguments": [ { "type": "reference", - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse" } ], @@ -10030,14 +10224,14 @@ ] }, { - "id": 986, + "id": 1007, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 987, + "id": 1008, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -10047,17 +10241,17 @@ }, "parameters": [ { - "id": 988, + "id": 1009, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "dereferenced": { - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -10072,14 +10266,14 @@ "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 922, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -10104,7 +10298,7 @@ { "title": "Properties", "kind": 1024, - "children": [901] + "children": [922] } ], "sources": [ @@ -10125,7 +10319,7 @@ "typeArguments": [ { "type": "reference", - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse" } ], @@ -10137,14 +10331,14 @@ ] }, { - "id": 983, + "id": 1004, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 1005, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -10154,17 +10348,17 @@ }, "parameters": [ { - "id": 985, + "id": 1006, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 902, + "id": 923, "name": "MFAVerifyParams", "dereferenced": { - "id": 902, + "id": 923, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -10179,14 +10373,14 @@ "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 924, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 926, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -10207,7 +10401,7 @@ } }, { - "id": 906, + "id": 927, "name": "code", "kind": 1024, "kindString": "Property", @@ -10228,7 +10422,7 @@ } }, { - "id": 904, + "id": 925, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -10253,7 +10447,7 @@ { "title": "Properties", "kind": 1024, - "children": [905, 906, 904] + "children": [926, 927, 925] } ], "sources": [ @@ -10274,7 +10468,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -10290,7 +10484,7 @@ { "title": "Methods", "kind": 2048, - "children": [980, 989, 973, 994, 992, 986, 983] + "children": [1001, 1010, 994, 1015, 1013, 1007, 1004] } ], "sources": [ @@ -10304,7 +10498,7 @@ } }, { - "id": 144, + "id": 147, "name": "exchangeCodeForSession", "kind": 2048, "kindString": "Method", @@ -10312,13 +10506,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 584, + "line": 593, "character": 8 } ], "signatures": [ { - "id": 145, + "id": 148, "name": "exchangeCodeForSession", "kind": 4096, "kindString": "Call signature", @@ -10328,7 +10522,7 @@ }, "parameters": [ { - "id": 146, + "id": 149, "name": "authCode", "kind": 32768, "kindString": "Parameter", @@ -10344,7 +10538,7 @@ "typeArguments": [ { "type": "reference", - "id": 574, + "id": 595, "name": "AuthTokenResponse" } ], @@ -10356,7 +10550,358 @@ ] }, { - "id": 183, + "id": 477, + "name": "getClaims", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2636, + "character": 8 + } + ], + "signatures": [ + { + "id": 478, + "name": "getClaims", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "experimental", + "text": "This method may change in future versions." + }, + { + "tag": "description", + "text": "Gets the claims from a JWT. If the JWT is symmetric JWTs, it will call getUser() to verify against the server. If the JWT is asymmetric, it will be verified against the JWKS using the WebCrypto API.\n" + } + ] + }, + "parameters": [ + { + "id": 479, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 480, + "name": "jwks", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 481, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 482, + "name": "keys", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2638, + "character": 12 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 1133, + "name": "JWK" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [482] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 484, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 485, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "claims", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 1129, + "name": "JwtPayload" + } + }, + { + "id": 487, + "name": "header", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 36 + } + ], + "type": { + "type": "reference", + "id": 1114, + "name": "JwtHeader" + } + }, + { + "id": 488, + "name": "signature", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2641, + "character": 55 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Uint8Array", + "package": "typescript", + "name": "Uint8Array" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [486, 487, 488] + } + ] + } + } + }, + { + "id": 489, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2642, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [484, 489] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 490, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 491, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2644, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 492, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2644, + "character": 20 + } + ], + "type": { + "type": "reference", + "id": 1158, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [491, 492] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 493, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 494, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2645, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 495, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2645, + "character": 20 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [494, 495] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 186, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -10364,13 +10909,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 935, + "line": 944, "character": 8 } ], "signatures": [ { - "id": 184, + "id": 187, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -10388,158 +10933,18 @@ { "type": "reflection", "declaration": { - "id": 185, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ - { - "id": 186, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1028, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 188, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1029, - "character": 14 - } - ], - "type": { - "type": "reference", - "id": 635, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [188] - } - ] - } - } - }, { "id": 189, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1031, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186, 189] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 191, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1034, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1035, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [193] - } - ] - } - } - }, - { - "id": 194, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -10547,55 +10952,17 @@ "character": 12 } ], - "type": { - "type": "reference", - "id": 1111, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [191, 194] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 195, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 196, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1040, - "character": 12 - } - ], "type": { "type": "reflection", "declaration": { - "id": 197, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 191, "name": "session", "kind": 1024, "kindString": "Property", @@ -10603,13 +10970,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1041, + "line": 1038, "character": 14 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 656, + "name": "Session" } } ], @@ -10617,14 +10985,14 @@ { "title": "Properties", "kind": 1024, - "children": [198] + "children": [191] } ] } } }, { - "id": 199, + "id": 192, "name": "error", "kind": 1024, "kindString": "Property", @@ -10632,7 +11000,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1043, + "line": 1040, "character": 12 } ], @@ -10646,7 +11014,184 @@ { "title": "Properties", "kind": 1024, - "children": [196, 199] + "children": [189, 192] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 193, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 194, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1043, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 195, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 196, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1044, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [196] + } + ] + } + } + }, + { + "id": 197, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1046, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 1158, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [194, 197] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 198, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 199, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1049, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 200, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 201, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1050, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [201] + } + ] + } + } + }, + { + "id": 202, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1052, + "character": 12 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [199, 202] } ] } @@ -10662,7 +11207,7 @@ ] }, { - "id": 246, + "id": 249, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -10670,13 +11215,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1166, + "line": 1175, "character": 8 } ], "signatures": [ { - "id": 247, + "id": 250, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -10686,7 +11231,7 @@ }, "parameters": [ { - "id": 248, + "id": 251, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -10707,7 +11252,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -10719,7 +11264,7 @@ ] }, { - "id": 362, + "id": 358, "name": "getUserIdentities", "kind": 2048, "kindString": "Method", @@ -10727,13 +11272,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1735, + "line": 1733, "character": 8 } ], "signatures": [ { - "id": 363, + "id": 359, "name": "getUserIdentities", "kind": 4096, "kindString": "Call signature", @@ -10750,14 +11295,14 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 361, "name": "data", "kind": 1024, "kindString": "Property", @@ -10765,21 +11310,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1737, + "line": 1735, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 366, + "id": 362, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 367, + "id": 363, "name": "identities", "kind": 1024, "kindString": "Property", @@ -10787,7 +11332,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1738, + "line": 1736, "character": 10 } ], @@ -10795,7 +11340,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } @@ -10805,18 +11350,55 @@ { "title": "Properties", "kind": 1024, - "children": [367] + "children": [363] } ] } } }, { - "id": 368, + "id": 364, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1738, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [361, 364] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 365, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 366, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -10828,46 +11410,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 368] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 370, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1742, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 371, + "id": 367, "name": "error", "kind": 1024, "kindString": "Property", @@ -10875,13 +11420,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1742, + "line": 1740, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -10890,7 +11435,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [366, 367] } ] } @@ -10906,7 +11451,7 @@ ] }, { - "id": 128, + "id": 131, "name": "initialize", "kind": 2048, "kindString": "Method", @@ -10914,13 +11459,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 286, + "line": 295, "character": 8 } ], "signatures": [ { - "id": 129, + "id": 132, "name": "initialize", "kind": 4096, "kindString": "Call signature", @@ -10933,7 +11478,7 @@ "typeArguments": [ { "type": "reference", - "id": 1031, + "id": 1052, "name": "InitializeResult" } ], @@ -10945,7 +11490,7 @@ ] }, { - "id": 372, + "id": 368, "name": "linkIdentity", "kind": 2048, "kindString": "Method", @@ -10953,13 +11498,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1759, + "line": 1757, "character": 8 } ], "signatures": [ { - "id": 373, + "id": 369, "name": "linkIdentity", "kind": 4096, "kindString": "Call signature", @@ -10969,17 +11514,17 @@ }, "parameters": [ { - "id": 374, + "id": 370, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -10994,14 +11539,14 @@ "type": { "type": "reflection", "declaration": { - "id": 781, + "id": 802, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 783, + "id": 804, "name": "options", "kind": 1024, "kindString": "Property", @@ -11018,14 +11563,14 @@ "type": { "type": "reflection", "declaration": { - "id": 784, + "id": 805, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 787, + "id": 808, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -11045,7 +11590,7 @@ "type": { "type": "reflection", "declaration": { - "id": 788, + "id": 809, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -11058,14 +11603,14 @@ } ], "indexSignature": { - "id": 789, + "id": 810, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 790, + "id": 811, "name": "key", "kind": 32768, "flags": {}, @@ -11084,7 +11629,7 @@ } }, { - "id": 785, + "id": 806, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -11107,7 +11652,7 @@ } }, { - "id": 786, + "id": 807, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -11130,7 +11675,7 @@ } }, { - "id": 791, + "id": 812, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -11157,7 +11702,7 @@ { "title": "Properties", "kind": 1024, - "children": [787, 785, 786, 791] + "children": [808, 806, 807, 812] } ], "sources": [ @@ -11171,7 +11716,7 @@ } }, { - "id": 782, + "id": 803, "name": "provider", "kind": 1024, "kindString": "Property", @@ -11188,10 +11733,10 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider", "dereferenced": { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -11307,7 +11852,7 @@ { "title": "Properties", "kind": 1024, - "children": [783, 782] + "children": [804, 803] } ], "sources": [ @@ -11328,7 +11873,7 @@ "typeArguments": [ { "type": "reference", - "id": 602, + "id": 623, "name": "OAuthResponse" } ], @@ -11340,7 +11885,7 @@ ] }, { - "id": 334, + "id": 330, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -11348,13 +11893,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1633, + "line": 1631, "character": 2 } ], "signatures": [ { - "id": 335, + "id": 331, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -11364,7 +11909,7 @@ }, "parameters": [ { - "id": 336, + "id": 332, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -11375,33 +11920,33 @@ "type": { "type": "reflection", "declaration": { - "id": 337, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 338, + "id": 334, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 339, + "id": 335, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent" } }, { - "id": 340, + "id": 336, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -11415,7 +11960,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -11452,14 +11997,14 @@ "type": { "type": "reflection", "declaration": { - "id": 341, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 338, "name": "data", "kind": 1024, "kindString": "Property", @@ -11467,21 +12012,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1636, + "line": 1634, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 343, + "id": 339, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 344, + "id": 340, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -11489,23 +12034,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1636, + "line": 1634, "character": 12 } ], "type": { "type": "reference", - "id": 718, + "id": 739, "name": "Subscription", "dereferenced": { - "id": 718, + "id": 739, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 719, + "id": 740, "name": "id", "kind": 1024, "kindString": "Property", @@ -11526,7 +12071,7 @@ } }, { - "id": 720, + "id": 741, "name": "callback", "kind": 2048, "kindString": "Method", @@ -11540,7 +12085,7 @@ ], "signatures": [ { - "id": 721, + "id": 742, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -11550,17 +12095,17 @@ }, "parameters": [ { - "id": 722, + "id": 743, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent", "dereferenced": { - "id": 495, + "id": 516, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -11600,7 +12145,7 @@ "value": "USER_UPDATED" }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -11623,7 +12168,7 @@ } }, { - "id": 723, + "id": 744, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -11637,7 +12182,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -11652,7 +12197,7 @@ ] }, { - "id": 724, + "id": 745, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -11666,7 +12211,7 @@ ], "signatures": [ { - "id": 725, + "id": 746, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -11686,12 +12231,12 @@ { "title": "Properties", "kind": 1024, - "children": [719] + "children": [740] }, { "title": "Methods", "kind": 2048, - "children": [720, 724] + "children": [741, 745] } ], "sources": [ @@ -11709,7 +12254,7 @@ { "title": "Properties", "kind": 1024, - "children": [344] + "children": [340] } ] } @@ -11720,7 +12265,7 @@ { "title": "Properties", "kind": 1024, - "children": [342] + "children": [338] } ] } @@ -11729,7 +12274,7 @@ ] }, { - "id": 176, + "id": 179, "name": "reauthenticate", "kind": 2048, "kindString": "Method", @@ -11737,13 +12282,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 851, + "line": 860, "character": 8 } ], "signatures": [ { - "id": 177, + "id": 180, "name": "reauthenticate", "kind": 4096, "kindString": "Call signature", @@ -11756,7 +12301,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -11768,7 +12313,7 @@ ] }, { - "id": 283, + "id": 279, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -11776,13 +12321,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1382, + "line": 1380, "character": 8 } ], "signatures": [ { - "id": 284, + "id": 280, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -11792,7 +12337,7 @@ }, "parameters": [ { - "id": 285, + "id": 281, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -11805,14 +12350,14 @@ "type": { "type": "reflection", "declaration": { - "id": 286, + "id": 282, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 283, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -11820,7 +12365,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1382, + "line": 1380, "character": 42 } ], @@ -11834,7 +12379,7 @@ { "title": "Properties", "kind": 1024, - "children": [287] + "children": [283] } ] } @@ -11846,7 +12391,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -11858,7 +12403,7 @@ ] }, { - "id": 180, + "id": 183, "name": "resend", "kind": 2048, "kindString": "Method", @@ -11866,13 +12411,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 886, + "line": 895, "character": 8 } ], "signatures": [ { - "id": 181, + "id": 184, "name": "resend", "kind": 4096, "kindString": "Call signature", @@ -11882,17 +12427,17 @@ }, "parameters": [ { - "id": 182, + "id": 185, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 824, + "id": 845, "name": "ResendParams", "dereferenced": { - "id": 824, + "id": 845, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -11910,14 +12455,14 @@ { "type": "reflection", "declaration": { - "id": 825, + "id": 846, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 827, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", @@ -11935,7 +12480,7 @@ } }, { - "id": 828, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -11952,14 +12497,14 @@ "type": { "type": "reflection", "declaration": { - "id": 829, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 831, + "id": 852, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11982,7 +12527,7 @@ } }, { - "id": 830, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -12009,7 +12554,7 @@ { "title": "Properties", "kind": 1024, - "children": [831, 830] + "children": [852, 851] } ], "sources": [ @@ -12023,7 +12568,7 @@ } }, { - "id": 826, + "id": 847, "name": "type", "kind": 1024, "kindString": "Property", @@ -12040,7 +12585,7 @@ "typeArguments": [ { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType" }, { @@ -12067,7 +12612,7 @@ { "title": "Properties", "kind": 1024, - "children": [827, 828, 826] + "children": [848, 849, 847] } ], "sources": [ @@ -12082,14 +12627,14 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 853, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -12106,14 +12651,14 @@ "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 857, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 858, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12140,7 +12685,7 @@ { "title": "Properties", "kind": 1024, - "children": [837] + "children": [858] } ], "sources": [ @@ -12154,7 +12699,7 @@ } }, { - "id": 834, + "id": 855, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12172,7 +12717,7 @@ } }, { - "id": 833, + "id": 854, "name": "type", "kind": 1024, "kindString": "Property", @@ -12189,7 +12734,7 @@ "typeArguments": [ { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType" }, { @@ -12216,7 +12761,7 @@ { "title": "Properties", "kind": 1024, - "children": [835, 834, 833] + "children": [856, 855, 854] } ], "sources": [ @@ -12239,7 +12784,7 @@ "typeArguments": [ { "type": "reference", - "id": 559, + "id": 580, "name": "AuthOtpResponse" } ], @@ -12251,7 +12796,7 @@ ] }, { - "id": 348, + "id": 344, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -12259,13 +12804,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1689, + "line": 1687, "character": 8 } ], "signatures": [ { - "id": 349, + "id": 345, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -12275,7 +12820,7 @@ }, "parameters": [ { - "id": 350, + "id": 346, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -12289,7 +12834,7 @@ } }, { - "id": 351, + "id": 347, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12297,14 +12842,14 @@ "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 350, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12317,7 +12862,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1693, + "line": 1691, "character": 6 } ], @@ -12327,7 +12872,7 @@ } }, { - "id": 353, + "id": 349, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -12340,7 +12885,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1692, + "line": 1690, "character": 6 } ], @@ -12354,7 +12899,7 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [350, 349] } ] } @@ -12368,6 +12913,67 @@ { "type": "union", "types": [ + { + "type": "reflection", + "declaration": { + "id": 351, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 352, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1695, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 353, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 354, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1696, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [352, 354] + } + ] + } + }, { "type": "reflection", "declaration": { @@ -12383,30 +12989,6 @@ "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1697, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 357, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 358, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -12418,46 +13000,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [356, 358] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1700, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 361, + "id": 357, "name": "error", "kind": 1024, "kindString": "Property", @@ -12465,13 +13010,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1700, + "line": 1698, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -12480,7 +13025,7 @@ { "title": "Properties", "kind": 1024, - "children": [360, 361] + "children": [356, 357] } ] } @@ -12496,7 +13041,7 @@ ] }, { - "id": 271, + "id": 267, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -12504,13 +13049,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1307, + "line": 1305, "character": 8 } ], "signatures": [ { - "id": 272, + "id": 268, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -12520,7 +13065,7 @@ }, "parameters": [ { - "id": 273, + "id": 269, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -12531,14 +13076,14 @@ "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 275, + "id": 271, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -12546,7 +13091,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1308, + "line": 1306, "character": 4 } ], @@ -12556,7 +13101,7 @@ } }, { - "id": 276, + "id": 272, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -12564,7 +13109,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1309, + "line": 1307, "character": 4 } ], @@ -12578,7 +13123,7 @@ { "title": "Properties", "kind": 1024, - "children": [275, 276] + "children": [271, 272] } ] } @@ -12590,7 +13135,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -12602,7 +13147,7 @@ ] }, { - "id": 132, + "id": 135, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", @@ -12610,13 +13155,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 389, + "line": 398, "character": 8 } ], "signatures": [ { - "id": 133, + "id": 136, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", @@ -12627,7 +13172,7 @@ }, "parameters": [ { - "id": 134, + "id": 137, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -12636,10 +13181,10 @@ }, "type": { "type": "reference", - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials", "dereferenced": { - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12654,14 +13199,14 @@ "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 748, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 728, + "id": 749, "name": "options", "kind": 1024, "kindString": "Property", @@ -12678,14 +13223,14 @@ "type": { "type": "reflection", "declaration": { - "id": 729, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 752, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12708,7 +13253,7 @@ } }, { - "id": 730, + "id": 751, "name": "data", "kind": 1024, "kindString": "Property", @@ -12736,7 +13281,7 @@ { "title": "Properties", "kind": 1024, - "children": [731, 730] + "children": [752, 751] } ], "sources": [ @@ -12754,7 +13299,7 @@ { "title": "Properties", "kind": 1024, - "children": [728] + "children": [749] } ], "sources": [ @@ -12775,7 +13320,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -12787,7 +13332,7 @@ ] }, { - "id": 164, + "id": 167, "name": "signInWithIdToken", "kind": 2048, "kindString": "Method", @@ -12795,13 +13340,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 644, + "line": 653, "character": 8 } ], "signatures": [ { - "id": 165, + "id": 168, "name": "signInWithIdToken", "kind": 4096, "kindString": "Call signature", @@ -12811,17 +13356,17 @@ }, "parameters": [ { - "id": 166, + "id": 169, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 792, + "id": 813, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 792, + "id": 813, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12836,14 +13381,14 @@ "type": { "type": "reflection", "declaration": { - "id": 793, + "id": 814, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -12866,7 +13411,7 @@ } }, { - "id": 798, + "id": 819, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -12889,7 +13434,7 @@ } }, { - "id": 799, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -12906,14 +13451,14 @@ "type": { "type": "reflection", "declaration": { - "id": 800, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 801, + "id": 822, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12940,7 +13485,7 @@ { "title": "Properties", "kind": 1024, - "children": [801] + "children": [822] } ], "sources": [ @@ -12954,7 +13499,7 @@ } }, { - "id": 794, + "id": 815, "name": "provider", "kind": 1024, "kindString": "Property", @@ -13002,7 +13547,7 @@ { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13022,7 +13567,7 @@ } }, { - "id": 796, + "id": 817, "name": "token", "kind": 1024, "kindString": "Property", @@ -13047,7 +13592,7 @@ { "title": "Properties", "kind": 1024, - "children": [797, 798, 799, 794, 796] + "children": [818, 819, 820, 815, 817] } ], "sources": [ @@ -13068,7 +13613,7 @@ "typeArguments": [ { "type": "reference", - "id": 574, + "id": 595, "name": "AuthTokenResponse" } ], @@ -13080,7 +13625,7 @@ ] }, { - "id": 141, + "id": 144, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -13088,13 +13633,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 572, + "line": 581, "character": 8 } ], "signatures": [ { - "id": 142, + "id": 145, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -13104,17 +13649,17 @@ }, "parameters": [ { - "id": 143, + "id": 146, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -13129,14 +13674,14 @@ "type": { "type": "reflection", "declaration": { - "id": 781, + "id": 802, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 783, + "id": 804, "name": "options", "kind": 1024, "kindString": "Property", @@ -13153,14 +13698,14 @@ "type": { "type": "reflection", "declaration": { - "id": 784, + "id": 805, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 787, + "id": 808, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -13180,7 +13725,7 @@ "type": { "type": "reflection", "declaration": { - "id": 788, + "id": 809, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13193,14 +13738,14 @@ } ], "indexSignature": { - "id": 789, + "id": 810, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 790, + "id": 811, "name": "key", "kind": 32768, "flags": {}, @@ -13219,7 +13764,7 @@ } }, { - "id": 785, + "id": 806, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -13242,7 +13787,7 @@ } }, { - "id": 786, + "id": 807, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -13265,7 +13810,7 @@ } }, { - "id": 791, + "id": 812, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -13292,7 +13837,7 @@ { "title": "Properties", "kind": 1024, - "children": [787, 785, 786, 791] + "children": [808, 806, 807, 812] } ], "sources": [ @@ -13306,7 +13851,7 @@ } }, { - "id": 782, + "id": 803, "name": "provider", "kind": 1024, "kindString": "Property", @@ -13323,10 +13868,10 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider", "dereferenced": { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -13442,7 +13987,7 @@ { "title": "Properties", "kind": 1024, - "children": [783, 782] + "children": [804, 803] } ], "sources": [ @@ -13463,7 +14008,7 @@ "typeArguments": [ { "type": "reference", - "id": 602, + "id": 623, "name": "OAuthResponse" } ], @@ -13475,7 +14020,7 @@ ] }, { - "id": 167, + "id": 170, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -13483,13 +14028,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 699, + "line": 708, "character": 8 } ], "signatures": [ { - "id": 168, + "id": 171, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -13500,17 +14045,17 @@ }, "parameters": [ { - "id": 169, + "id": 172, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 762, + "id": 783, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 762, + "id": 783, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -13528,14 +14073,14 @@ { "type": "reflection", "declaration": { - "id": 763, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 764, + "id": 785, "name": "email", "kind": 1024, "kindString": "Property", @@ -13556,7 +14101,7 @@ } }, { - "id": 765, + "id": 786, "name": "options", "kind": 1024, "kindString": "Property", @@ -13573,14 +14118,14 @@ "type": { "type": "reflection", "declaration": { - "id": 766, + "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 770, + "id": 791, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13603,7 +14148,7 @@ } }, { - "id": 769, + "id": 790, "name": "data", "kind": 1024, "kindString": "Property", @@ -13627,7 +14172,7 @@ } }, { - "id": 767, + "id": 788, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -13650,7 +14195,7 @@ } }, { - "id": 768, + "id": 789, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -13677,7 +14222,7 @@ { "title": "Properties", "kind": 1024, - "children": [770, 769, 767, 768] + "children": [791, 790, 788, 789] } ], "sources": [ @@ -13695,7 +14240,7 @@ { "title": "Properties", "kind": 1024, - "children": [764, 765] + "children": [785, 786] } ], "sources": [ @@ -13710,14 +14255,14 @@ { "type": "reflection", "declaration": { - "id": 771, + "id": 792, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 773, + "id": 794, "name": "options", "kind": 1024, "kindString": "Property", @@ -13734,14 +14279,14 @@ "type": { "type": "reflection", "declaration": { - "id": 774, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 777, + "id": 798, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13764,7 +14309,7 @@ } }, { - "id": 778, + "id": 799, "name": "channel", "kind": 1024, "kindString": "Property", @@ -13796,7 +14341,7 @@ } }, { - "id": 776, + "id": 797, "name": "data", "kind": 1024, "kindString": "Property", @@ -13820,7 +14365,7 @@ } }, { - "id": 775, + "id": 796, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -13847,7 +14392,7 @@ { "title": "Properties", "kind": 1024, - "children": [777, 778, 776, 775] + "children": [798, 799, 797, 796] } ], "sources": [ @@ -13861,7 +14406,7 @@ } }, { - "id": 772, + "id": 793, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13886,7 +14431,7 @@ { "title": "Properties", "kind": 1024, - "children": [773, 772] + "children": [794, 793] } ], "sources": [ @@ -13909,7 +14454,7 @@ "typeArguments": [ { "type": "reference", - "id": 559, + "id": 580, "name": "AuthOtpResponse" } ], @@ -13921,7 +14466,7 @@ ] }, { - "id": 138, + "id": 141, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -13929,13 +14474,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 509, + "line": 518, "character": 8 } ], "signatures": [ { - "id": 139, + "id": 142, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -13946,17 +14491,17 @@ }, "parameters": [ { - "id": 140, + "id": 143, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -13974,14 +14519,14 @@ { "type": "reflection", "declaration": { - "id": 750, + "id": 771, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 751, + "id": 772, "name": "email", "kind": 1024, "kindString": "Property", @@ -14002,7 +14547,7 @@ } }, { - "id": 753, + "id": 774, "name": "options", "kind": 1024, "kindString": "Property", @@ -14019,14 +14564,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 775, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 755, + "id": 776, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14053,7 +14598,7 @@ { "title": "Properties", "kind": 1024, - "children": [755] + "children": [776] } ], "sources": [ @@ -14067,7 +14612,7 @@ } }, { - "id": 752, + "id": 773, "name": "password", "kind": 1024, "kindString": "Property", @@ -14092,7 +14637,7 @@ { "title": "Properties", "kind": 1024, - "children": [751, 753, 752] + "children": [772, 774, 773] } ], "sources": [ @@ -14107,14 +14652,14 @@ { "type": "reflection", "declaration": { - "id": 756, + "id": 777, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 759, + "id": 780, "name": "options", "kind": 1024, "kindString": "Property", @@ -14131,14 +14676,14 @@ "type": { "type": "reflection", "declaration": { - "id": 760, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 782, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14165,7 +14710,7 @@ { "title": "Properties", "kind": 1024, - "children": [761] + "children": [782] } ], "sources": [ @@ -14179,7 +14724,7 @@ } }, { - "id": 758, + "id": 779, "name": "password", "kind": 1024, "kindString": "Property", @@ -14200,7 +14745,7 @@ } }, { - "id": 757, + "id": 778, "name": "phone", "kind": 1024, "kindString": "Property", @@ -14225,7 +14770,7 @@ { "title": "Properties", "kind": 1024, - "children": [759, 758, 757] + "children": [780, 779, 778] } ], "sources": [ @@ -14248,7 +14793,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 608, "name": "AuthTokenResponsePassword" } ], @@ -14260,7 +14805,7 @@ ] }, { - "id": 173, + "id": 176, "name": "signInWithSSO", "kind": 2048, "kindString": "Method", @@ -14268,13 +14813,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 813, + "line": 822, "character": 8 } ], "signatures": [ { - "id": 174, + "id": 177, "name": "signInWithSSO", "kind": 4096, "kindString": "Call signature", @@ -14285,17 +14830,17 @@ }, "parameters": [ { - "id": 175, + "id": 178, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 838, + "id": 859, "name": "SignInWithSSO", "dereferenced": { - "id": 838, + "id": 859, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -14313,14 +14858,14 @@ { "type": "reflection", "declaration": { - "id": 839, + "id": 860, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 862, "name": "options", "kind": 1024, "kindString": "Property", @@ -14337,14 +14882,14 @@ "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14367,7 +14912,7 @@ } }, { - "id": 843, + "id": 864, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -14394,7 +14939,7 @@ { "title": "Properties", "kind": 1024, - "children": [844, 843] + "children": [865, 864] } ], "sources": [ @@ -14408,7 +14953,7 @@ } }, { - "id": 840, + "id": 861, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -14433,7 +14978,7 @@ { "title": "Properties", "kind": 1024, - "children": [841, 840] + "children": [862, 861] } ], "sources": [ @@ -14448,14 +14993,14 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 866, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 867, "name": "domain", "kind": 1024, "kindString": "Property", @@ -14476,7 +15021,7 @@ } }, { - "id": 847, + "id": 868, "name": "options", "kind": 1024, "kindString": "Property", @@ -14493,14 +15038,14 @@ "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 869, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 850, + "id": 871, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14523,7 +15068,7 @@ } }, { - "id": 849, + "id": 870, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -14550,7 +15095,7 @@ { "title": "Properties", "kind": 1024, - "children": [850, 849] + "children": [871, 870] } ], "sources": [ @@ -14568,7 +15113,7 @@ { "title": "Properties", "kind": 1024, - "children": [846, 847] + "children": [867, 868] } ], "sources": [ @@ -14591,7 +15136,7 @@ "typeArguments": [ { "type": "reference", - "id": 615, + "id": 636, "name": "SSOResponse" } ], @@ -14603,7 +15148,7 @@ ] }, { - "id": 324, + "id": 320, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -14611,13 +15156,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1589, + "line": 1587, "character": 8 } ], "signatures": [ { - "id": 325, + "id": 321, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -14628,17 +15173,17 @@ }, "parameters": [ { - "id": 326, + "id": 322, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1052, + "id": 1073, "name": "SignOut", "dereferenced": { - "id": 1052, + "id": 1073, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -14653,14 +15198,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1053, + "id": 1074, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1054, + "id": 1075, "name": "scope", "kind": 1024, "kindString": "Property", @@ -14700,7 +15245,7 @@ { "title": "Properties", "kind": 1024, - "children": [1054] + "children": [1075] } ], "sources": [ @@ -14723,14 +15268,14 @@ { "type": "reflection", "declaration": { - "id": 327, + "id": 323, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 328, + "id": 324, "name": "error", "kind": 1024, "kindString": "Property", @@ -14738,7 +15283,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1589, + "line": 1587, "character": 67 } ], @@ -14751,7 +15296,7 @@ }, { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } ] @@ -14762,7 +15307,7 @@ { "title": "Properties", "kind": 1024, - "children": [328] + "children": [324] } ] } @@ -14776,7 +15321,7 @@ ] }, { - "id": 135, + "id": 138, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -14784,13 +15329,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 432, + "line": 441, "character": 8 } ], "signatures": [ { - "id": 136, + "id": 139, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -14802,17 +15347,17 @@ }, "parameters": [ { - "id": 137, + "id": 140, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -14830,14 +15375,14 @@ { "type": "reflection", "declaration": { - "id": 733, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 734, + "id": 755, "name": "email", "kind": 1024, "kindString": "Property", @@ -14858,7 +15403,7 @@ } }, { - "id": 736, + "id": 757, "name": "options", "kind": 1024, "kindString": "Property", @@ -14875,14 +15420,14 @@ "type": { "type": "reflection", "declaration": { - "id": 737, + "id": 758, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 740, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14905,7 +15450,7 @@ } }, { - "id": 739, + "id": 760, "name": "data", "kind": 1024, "kindString": "Property", @@ -14929,7 +15474,7 @@ } }, { - "id": 738, + "id": 759, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -14956,7 +15501,7 @@ { "title": "Properties", "kind": 1024, - "children": [740, 739, 738] + "children": [761, 760, 759] } ], "sources": [ @@ -14970,7 +15515,7 @@ } }, { - "id": 735, + "id": 756, "name": "password", "kind": 1024, "kindString": "Property", @@ -14995,7 +15540,7 @@ { "title": "Properties", "kind": 1024, - "children": [734, 736, 735] + "children": [755, 757, 756] } ], "sources": [ @@ -15010,14 +15555,14 @@ { "type": "reflection", "declaration": { - "id": 741, + "id": 762, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -15034,14 +15579,14 @@ "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 747, + "id": 768, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15064,7 +15609,7 @@ } }, { - "id": 748, + "id": 769, "name": "channel", "kind": 1024, "kindString": "Property", @@ -15096,7 +15641,7 @@ } }, { - "id": 746, + "id": 767, "name": "data", "kind": 1024, "kindString": "Property", @@ -15124,7 +15669,7 @@ { "title": "Properties", "kind": 1024, - "children": [747, 748, 746] + "children": [768, 769, 767] } ], "sources": [ @@ -15138,7 +15683,7 @@ } }, { - "id": 743, + "id": 764, "name": "password", "kind": 1024, "kindString": "Property", @@ -15159,7 +15704,7 @@ } }, { - "id": 742, + "id": 763, "name": "phone", "kind": 1024, "kindString": "Property", @@ -15184,7 +15729,7 @@ { "title": "Properties", "kind": 1024, - "children": [744, 743, 742] + "children": [765, 764, 763] } ], "sources": [ @@ -15207,7 +15752,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -15219,7 +15764,7 @@ ] }, { - "id": 430, + "id": 426, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -15227,13 +15772,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2174, + "line": 2172, "character": 8 } ], "signatures": [ { - "id": 431, + "id": 427, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -15258,7 +15803,7 @@ ] }, { - "id": 432, + "id": 428, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -15266,13 +15811,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2187, + "line": 2185, "character": 8 } ], "signatures": [ { - "id": 433, + "id": 429, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -15297,7 +15842,7 @@ ] }, { - "id": 375, + "id": 371, "name": "unlinkIdentity", "kind": 2048, "kindString": "Method", @@ -15305,13 +15850,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1795, + "line": 1793, "character": 8 } ], "signatures": [ { - "id": 376, + "id": 372, "name": "unlinkIdentity", "kind": 4096, "kindString": "Call signature", @@ -15321,24 +15866,24 @@ }, "parameters": [ { - "id": 377, + "id": 373, "name": "identity", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity", "dereferenced": { - "id": 648, + "id": 669, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 657, + "id": 678, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -15358,7 +15903,7 @@ } }, { - "id": 649, + "id": 670, "name": "id", "kind": 1024, "kindString": "Property", @@ -15376,7 +15921,7 @@ } }, { - "id": 651, + "id": 672, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -15393,20 +15938,20 @@ "type": { "type": "reflection", "declaration": { - "id": 652, + "id": 673, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 653, + "id": 674, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 654, + "id": 675, "name": "key", "kind": 32768, "flags": {}, @@ -15425,7 +15970,7 @@ } }, { - "id": 655, + "id": 676, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -15443,7 +15988,7 @@ } }, { - "id": 658, + "id": 679, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -15463,7 +16008,7 @@ } }, { - "id": 656, + "id": 677, "name": "provider", "kind": 1024, "kindString": "Property", @@ -15481,7 +16026,7 @@ } }, { - "id": 659, + "id": 680, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -15501,7 +16046,7 @@ } }, { - "id": 650, + "id": 671, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -15523,7 +16068,7 @@ { "title": "Properties", "kind": 1024, - "children": [657, 649, 651, 655, 658, 656, 659, 650] + "children": [678, 670, 672, 676, 679, 677, 680, 671] } ], "sources": [ @@ -15543,6 +16088,67 @@ { "type": "union", "types": [ + { + "type": "reflection", + "declaration": { + "id": 374, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1795, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 376, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 377, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1796, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [375, 377] + } + ] + } + }, { "type": "reflection", "declaration": { @@ -15558,30 +16164,6 @@ "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1797, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 380, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 381, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", @@ -15593,46 +16175,9 @@ "type": "literal", "value": null } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [379, 381] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 383, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1800, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } }, { - "id": 384, + "id": 380, "name": "error", "kind": 1024, "kindString": "Property", @@ -15640,13 +16185,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1800, + "line": 1798, "character": 20 } ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -15655,7 +16200,7 @@ { "title": "Properties", "kind": 1024, - "children": [383, 384] + "children": [379, 380] } ] } @@ -15671,7 +16216,7 @@ ] }, { - "id": 252, + "id": 255, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -15679,13 +16224,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1227, + "line": 1236, "character": 8 } ], "signatures": [ { - "id": 253, + "id": 256, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -15695,24 +16240,24 @@ }, "parameters": [ { - "id": 254, + "id": 257, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes", "dereferenced": { - "id": 699, + "id": 720, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 704, + "id": 725, "name": "data", "kind": 1024, "kindString": "Property", @@ -15736,7 +16281,7 @@ } }, { - "id": 700, + "id": 721, "name": "email", "kind": 1024, "kindString": "Property", @@ -15759,7 +16304,7 @@ } }, { - "id": 703, + "id": 724, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -15783,7 +16328,7 @@ } }, { - "id": 702, + "id": 723, "name": "password", "kind": 1024, "kindString": "Property", @@ -15806,7 +16351,7 @@ } }, { - "id": 701, + "id": 722, "name": "phone", "kind": 1024, "kindString": "Property", @@ -15833,7 +16378,7 @@ { "title": "Properties", "kind": 1024, - "children": [704, 700, 703, 702, 701] + "children": [725, 721, 724, 723, 722] } ], "sources": [ @@ -15847,7 +16392,7 @@ } }, { - "id": 255, + "id": 258, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15855,14 +16400,14 @@ "type": { "type": "reflection", "declaration": { - "id": 256, + "id": 259, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 260, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -15872,7 +16417,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1230, + "line": 1239, "character": 6 } ], @@ -15886,7 +16431,7 @@ { "title": "Properties", "kind": 1024, - "children": [257] + "children": [260] } ] } @@ -15899,7 +16444,7 @@ "typeArguments": [ { "type": "reference", - "id": 624, + "id": 645, "name": "UserResponse" } ], @@ -15911,7 +16456,7 @@ ] }, { - "id": 170, + "id": 173, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -15919,13 +16464,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 752, + "line": 761, "character": 8 } ], "signatures": [ { - "id": 171, + "id": 174, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -15935,17 +16480,17 @@ }, "parameters": [ { - "id": 172, + "id": 175, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 802, + "id": 823, "name": "VerifyOtpParams", "dereferenced": { - "id": 802, + "id": 823, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -15961,14 +16506,14 @@ "type": "union", "types": [ { - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -15985,14 +16530,14 @@ "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16021,7 +16566,7 @@ } }, { - "id": 809, + "id": 830, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -16048,14 +16593,14 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ] } } }, { - "id": 804, + "id": 825, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16076,7 +16621,7 @@ } }, { - "id": 805, + "id": 826, "name": "token", "kind": 1024, "kindString": "Property", @@ -16097,7 +16642,7 @@ } }, { - "id": 806, + "id": 827, "name": "type", "kind": 1024, "kindString": "Property", @@ -16114,10 +16659,10 @@ ], "type": { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType", "dereferenced": { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -16150,7 +16695,7 @@ { "title": "Properties", "kind": 1024, - "children": [807, 804, 805, 806] + "children": [828, 825, 826, 827] } ], "sources": [ @@ -16162,14 +16707,14 @@ ] }, { - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 812, + "id": 833, "name": "email", "kind": 1024, "kindString": "Property", @@ -16190,7 +16735,7 @@ } }, { - "id": 815, + "id": 836, "name": "options", "kind": 1024, "kindString": "Property", @@ -16207,14 +16752,14 @@ "type": { "type": "reflection", "declaration": { - "id": 816, + "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 818, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16243,7 +16788,7 @@ } }, { - "id": 817, + "id": 838, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -16270,14 +16815,14 @@ { "title": "Properties", "kind": 1024, - "children": [818, 817] + "children": [839, 838] } ] } } }, { - "id": 813, + "id": 834, "name": "token", "kind": 1024, "kindString": "Property", @@ -16298,7 +16843,7 @@ } }, { - "id": 814, + "id": 835, "name": "type", "kind": 1024, "kindString": "Property", @@ -16315,10 +16860,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -16367,7 +16912,7 @@ { "title": "Properties", "kind": 1024, - "children": [812, 815, 813, 814] + "children": [833, 836, 834, 835] } ], "sources": [ @@ -16379,14 +16924,14 @@ ] }, { - "id": 819, + "id": 840, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -16407,7 +16952,7 @@ } }, { - "id": 821, + "id": 842, "name": "type", "kind": 1024, "kindString": "Property", @@ -16424,10 +16969,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -16476,7 +17021,7 @@ { "title": "Properties", "kind": 1024, - "children": [820, 821] + "children": [841, 842] } ], "sources": [ @@ -16498,7 +17043,7 @@ "typeArguments": [ { "type": "reference", - "id": 532, + "id": 553, "name": "AuthResponse" } ], @@ -16525,42 +17070,42 @@ "title": "Methods", "kind": 2048, "children": [ - 144, 183, 246, 362, 128, 372, 334, 176, 283, 180, 348, 271, 132, 164, 141, 167, 138, - 173, 324, 135, 430, 432, 375, 252, 170 + 147, 477, 186, 249, 358, 131, 368, 330, 179, 279, 183, 344, 267, 135, 167, 144, 170, + 141, 176, 320, 138, 426, 428, 371, 255, 173 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 123, + "line": 129, "character": 21 } ] }, { - "id": 485, + "id": 506, "name": "NavigatorLockAcquireTimeoutError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 486, + "id": 507, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 487, + "id": 508, "name": "new NavigatorLockAcquireTimeoutError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 488, + "id": 509, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -16573,7 +17118,7 @@ ], "type": { "type": "reference", - "id": 485, + "id": 506, "name": "NavigatorLockAcquireTimeoutError" }, "inheritedFrom": { @@ -16588,7 +17133,7 @@ } }, { - "id": 489, + "id": 510, "name": "isAcquireTimeout", "kind": 1024, "kindString": "Property", @@ -16618,12 +17163,12 @@ { "title": "Constructors", "kind": 512, - "children": [486] + "children": [507] }, { "title": "Properties", "kind": 1024, - "children": [489] + "children": [510] } ], "sources": [ @@ -16641,7 +17186,7 @@ ] }, { - "id": 644, + "id": 665, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -16658,7 +17203,7 @@ }, "children": [ { - "id": 645, + "id": 666, "name": "method", "kind": 1024, "kindString": "Property", @@ -16690,7 +17235,7 @@ { "type": "reflection", "declaration": { - "id": 646, + "id": 667, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -16715,7 +17260,7 @@ } }, { - "id": 647, + "id": 668, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -16740,7 +17285,7 @@ { "title": "Properties", "kind": 1024, - "children": [645, 647] + "children": [666, 668] } ], "sources": [ @@ -16752,14 +17297,14 @@ ] }, { - "id": 705, + "id": 726, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 707, + "id": 728, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -16783,7 +17328,7 @@ } }, { - "id": 710, + "id": 731, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -16807,7 +17352,7 @@ } }, { - "id": 717, + "id": 738, "name": "email", "kind": 1024, "kindString": "Property", @@ -16834,7 +17379,7 @@ } }, { - "id": 708, + "id": 729, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -16858,7 +17403,7 @@ } }, { - "id": 713, + "id": 734, "name": "id", "kind": 1024, "kindString": "Property", @@ -16882,7 +17427,7 @@ } }, { - "id": 715, + "id": 736, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -16910,7 +17455,7 @@ } }, { - "id": 714, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -16937,7 +17482,7 @@ } }, { - "id": 712, + "id": 733, "name": "password_hash", "kind": 1024, "kindString": "Property", @@ -16961,7 +17506,7 @@ } }, { - "id": 716, + "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16988,7 +17533,7 @@ } }, { - "id": 709, + "id": 730, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -17012,7 +17557,7 @@ } }, { - "id": 711, + "id": 732, "name": "role", "kind": 1024, "kindString": "Property", @@ -17036,7 +17581,7 @@ } }, { - "id": 706, + "id": 727, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -17064,7 +17609,7 @@ { "title": "Properties", "kind": 1024, - "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] + "children": [728, 731, 738, 729, 734, 736, 735, 733, 737, 730, 732, 727] } ], "sources": [ @@ -17080,7 +17625,7 @@ "typeArguments": [ { "type": "reference", - "id": 699, + "id": 720, "name": "UserAttributes" }, { @@ -17095,7 +17640,7 @@ ] }, { - "id": 660, + "id": 681, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -17119,7 +17664,7 @@ }, "children": [ { - "id": 666, + "id": 687, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -17137,7 +17682,7 @@ } }, { - "id": 663, + "id": 684, "name": "factor_type", "kind": 1024, "kindString": "Property", @@ -17165,7 +17710,7 @@ { "type": "reflection", "declaration": { - "id": 664, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -17186,7 +17731,7 @@ } }, { - "id": 662, + "id": 683, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -17209,7 +17754,7 @@ } }, { - "id": 661, + "id": 682, "name": "id", "kind": 1024, "kindString": "Property", @@ -17230,7 +17775,7 @@ } }, { - "id": 665, + "id": 686, "name": "status", "kind": 1024, "kindString": "Property", @@ -17260,7 +17805,7 @@ } }, { - "id": 667, + "id": 688, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -17282,7 +17827,7 @@ { "title": "Properties", "kind": 1024, - "children": [666, 663, 662, 661, 665, 667] + "children": [687, 684, 683, 682, 686, 688] } ], "sources": [ @@ -17294,14 +17839,14 @@ ] }, { - "id": 873, + "id": 894, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 874, + "id": 895, "name": "data", "kind": 1024, "kindString": "Property", @@ -17325,7 +17870,7 @@ } }, { - "id": 875, + "id": 896, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17352,7 +17897,7 @@ { "title": "Properties", "kind": 1024, - "children": [874, 875] + "children": [895, 896] } ], "sources": [ @@ -17364,7 +17909,7 @@ ] }, { - "id": 1021, + "id": 1042, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -17380,14 +17925,14 @@ }, "children": [ { - "id": 1025, + "id": 1046, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1026, + "id": 1047, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -17407,17 +17952,17 @@ }, "parameters": [ { - "id": 1027, + "id": 1048, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -17440,14 +17985,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -17468,7 +18013,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -17493,7 +18038,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -17514,7 +18059,7 @@ "typeArguments": [ { "type": "reference", - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -17526,14 +18071,14 @@ ] }, { - "id": 1022, + "id": 1043, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1023, + "id": 1044, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -17543,17 +18088,17 @@ }, "parameters": [ { - "id": 1024, + "id": 1045, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -17576,14 +18121,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -17608,7 +18153,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -17629,7 +18174,7 @@ "typeArguments": [ { "type": "reference", - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -17645,7 +18190,7 @@ { "title": "Methods", "kind": 2048, - "children": [1025, 1022] + "children": [1046, 1043] } ], "sources": [ @@ -17657,7 +18202,7 @@ ] }, { - "id": 972, + "id": 993, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -17667,14 +18212,14 @@ }, "children": [ { - "id": 980, + "id": 1001, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 1002, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -17684,17 +18229,17 @@ }, "parameters": [ { - "id": 982, + "id": 1003, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 907, + "id": 928, "name": "MFAChallengeParams", "dereferenced": { - "id": 907, + "id": 928, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -17709,14 +18254,14 @@ "type": { "type": "reflection", "declaration": { - "id": 908, + "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 910, + "id": 931, "name": "channel", "kind": 1024, "kindString": "Property", @@ -17748,7 +18293,7 @@ } }, { - "id": 909, + "id": 930, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17773,7 +18318,7 @@ { "title": "Properties", "kind": 1024, - "children": [910, 909] + "children": [931, 930] } ], "sources": [ @@ -17794,7 +18339,7 @@ "typeArguments": [ { "type": "reference", - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse" } ], @@ -17806,14 +18351,14 @@ ] }, { - "id": 989, + "id": 1010, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 990, + "id": 1011, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -17823,17 +18368,17 @@ }, "parameters": [ { - "id": 991, + "id": 1012, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17848,14 +18393,14 @@ "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 933, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 914, + "id": 935, "name": "code", "kind": 1024, "kindString": "Property", @@ -17876,7 +18421,7 @@ } }, { - "id": 913, + "id": 934, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17901,7 +18446,7 @@ { "title": "Properties", "kind": 1024, - "children": [914, 913] + "children": [935, 934] } ], "sources": [ @@ -17922,7 +18467,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -17934,14 +18479,14 @@ ] }, { - "id": 973, + "id": 994, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 974, + "id": 995, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -17952,17 +18497,17 @@ }, "parameters": [ { - "id": 975, + "id": 996, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -17977,14 +18522,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -18005,7 +18550,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -18028,7 +18573,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -18055,7 +18600,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -18076,7 +18621,7 @@ "typeArguments": [ { "type": "reference", - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse" } ], @@ -18086,24 +18631,24 @@ } }, { - "id": 976, + "id": 997, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 977, + "id": 998, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -18118,14 +18663,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -18146,7 +18691,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -18169,7 +18714,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18194,7 +18739,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -18215,7 +18760,7 @@ "typeArguments": [ { "type": "reference", - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse" } ], @@ -18225,24 +18770,24 @@ } }, { - "id": 978, + "id": 999, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 979, + "id": 1000, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 898, + "id": 919, "name": "MFAEnrollParams", "dereferenced": { - "id": 898, + "id": 919, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -18258,7 +18803,7 @@ "type": "union", "types": [ { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -18273,14 +18818,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -18301,7 +18846,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -18324,7 +18869,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -18351,7 +18896,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -18365,7 +18910,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -18380,14 +18925,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -18408,7 +18953,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -18431,7 +18976,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18456,7 +19001,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -18480,7 +19025,7 @@ "typeArguments": [ { "type": "reference", - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse" } ], @@ -18492,14 +19037,14 @@ ] }, { - "id": 994, + "id": 1015, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 995, + "id": 1016, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -18513,7 +19058,7 @@ "typeArguments": [ { "type": "reference", - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -18525,14 +19070,14 @@ ] }, { - "id": 992, + "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 993, + "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -18559,7 +19104,7 @@ "typeArguments": [ { "type": "reference", - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse" } ], @@ -18571,14 +19116,14 @@ ] }, { - "id": 986, + "id": 1007, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 987, + "id": 1008, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -18588,17 +19133,17 @@ }, "parameters": [ { - "id": 988, + "id": 1009, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "dereferenced": { - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -18613,14 +19158,14 @@ "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 922, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -18645,7 +19190,7 @@ { "title": "Properties", "kind": 1024, - "children": [901] + "children": [922] } ], "sources": [ @@ -18666,7 +19211,7 @@ "typeArguments": [ { "type": "reference", - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse" } ], @@ -18678,14 +19223,14 @@ ] }, { - "id": 983, + "id": 1004, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 1005, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -18695,17 +19240,17 @@ }, "parameters": [ { - "id": 985, + "id": 1006, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 902, + "id": 923, "name": "MFAVerifyParams", "dereferenced": { - "id": 902, + "id": 923, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -18720,14 +19265,14 @@ "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 924, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 926, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -18748,7 +19293,7 @@ } }, { - "id": 906, + "id": 927, "name": "code", "kind": 1024, "kindString": "Property", @@ -18769,7 +19314,7 @@ } }, { - "id": 904, + "id": 925, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -18794,7 +19339,7 @@ { "title": "Properties", "kind": 1024, - "children": [905, 906, 904] + "children": [926, 927, 925] } ], "sources": [ @@ -18815,7 +19360,7 @@ "typeArguments": [ { "type": "reference", - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse" } ], @@ -18831,7 +19376,7 @@ { "title": "Methods", "kind": 2048, - "children": [980, 989, 973, 994, 992, 986, 983] + "children": [1001, 1010, 994, 1015, 1013, 1007, 1004] } ], "sources": [ @@ -18843,14 +19388,152 @@ ] }, { - "id": 635, + "id": 1133, + "name": "JWK", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 1136, + "name": "alg", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1227, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1135, + "name": "key_ops", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1226, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1137, + "name": "kid", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1228, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1134, + "name": "kty", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1225, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "RSA" + }, + { + "type": "literal", + "value": "EC" + }, + { + "type": "literal", + "value": "oct" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1136, 1135, 1137, 1134] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1224, + "character": 17 + } + ], + "indexSignature": { + "id": 1138, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 1139, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 656, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 638, + "id": 659, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -18871,7 +19554,7 @@ } }, { - "id": 641, + "id": 662, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -18894,7 +19577,7 @@ } }, { - "id": 640, + "id": 661, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -18915,7 +19598,7 @@ } }, { - "id": 637, + "id": 658, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -18947,7 +19630,7 @@ } }, { - "id": 636, + "id": 657, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -18979,7 +19662,7 @@ } }, { - "id": 639, + "id": 660, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -19000,7 +19683,7 @@ } }, { - "id": 642, + "id": 663, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -19018,7 +19701,7 @@ } }, { - "id": 643, + "id": 664, "name": "user", "kind": 1024, "kindString": "Property", @@ -19032,17 +19715,17 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User", "dereferenced": { - "id": 675, + "id": 696, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 686, + "id": 707, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -19062,7 +19745,7 @@ } }, { - "id": 677, + "id": 698, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -19076,17 +19759,17 @@ ], "type": { "type": "reference", - "id": 668, + "id": 689, "name": "UserAppMetadata", "dereferenced": { - "id": 668, + "id": 689, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 669, + "id": 690, "name": "provider", "kind": 1024, "kindString": "Property", @@ -19110,7 +19793,7 @@ { "title": "Properties", "kind": 1024, - "children": [669] + "children": [690] } ], "sources": [ @@ -19121,14 +19804,14 @@ } ], "indexSignature": { - "id": 670, + "id": 691, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 692, "name": "key", "kind": 32768, "flags": {}, @@ -19147,7 +19830,7 @@ } }, { - "id": 679, + "id": 700, "name": "aud", "kind": 1024, "kindString": "Property", @@ -19165,7 +19848,7 @@ } }, { - "id": 680, + "id": 701, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -19185,7 +19868,7 @@ } }, { - "id": 690, + "id": 711, "name": "confirmed_at", "kind": 1024, "kindString": "Property", @@ -19205,7 +19888,7 @@ } }, { - "id": 689, + "id": 710, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -19223,7 +19906,7 @@ } }, { - "id": 687, + "id": 708, "name": "email", "kind": 1024, "kindString": "Property", @@ -19243,7 +19926,7 @@ } }, { - "id": 682, + "id": 703, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", @@ -19263,7 +19946,7 @@ } }, { - "id": 691, + "id": 712, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", @@ -19283,7 +19966,7 @@ } }, { - "id": 698, + "id": 719, "name": "factors", "kind": 1024, "kindString": "Property", @@ -19301,13 +19984,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 676, + "id": 697, "name": "id", "kind": 1024, "kindString": "Property", @@ -19325,7 +20008,7 @@ } }, { - "id": 696, + "id": 717, "name": "identities", "kind": 1024, "kindString": "Property", @@ -19343,13 +20026,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } }, { - "id": 685, + "id": 706, "name": "invited_at", "kind": 1024, "kindString": "Property", @@ -19369,7 +20052,7 @@ } }, { - "id": 697, + "id": 718, "name": "is_anonymous", "kind": 1024, "kindString": "Property", @@ -19389,7 +20072,7 @@ } }, { - "id": 693, + "id": 714, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -19409,7 +20092,7 @@ } }, { - "id": 683, + "id": 704, "name": "new_email", "kind": 1024, "kindString": "Property", @@ -19429,7 +20112,7 @@ } }, { - "id": 684, + "id": 705, "name": "new_phone", "kind": 1024, "kindString": "Property", @@ -19449,7 +20132,7 @@ } }, { - "id": 688, + "id": 709, "name": "phone", "kind": 1024, "kindString": "Property", @@ -19469,7 +20152,7 @@ } }, { - "id": 692, + "id": 713, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", @@ -19489,7 +20172,7 @@ } }, { - "id": 681, + "id": 702, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -19509,7 +20192,7 @@ } }, { - "id": 694, + "id": 715, "name": "role", "kind": 1024, "kindString": "Property", @@ -19529,7 +20212,7 @@ } }, { - "id": 695, + "id": 716, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -19549,7 +20232,7 @@ } }, { - "id": 678, + "id": 699, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -19563,10 +20246,10 @@ ], "type": { "type": "reference", - "id": 672, + "id": 693, "name": "UserMetadata", "dereferenced": { - "id": 672, + "id": 693, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -19579,14 +20262,14 @@ } ], "indexSignature": { - "id": 673, + "id": 694, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 674, + "id": 695, "name": "key", "kind": 32768, "flags": {}, @@ -19610,8 +20293,8 @@ "title": "Properties", "kind": 1024, "children": [ - 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, - 684, 688, 692, 681, 694, 695, 678 + 707, 698, 700, 701, 711, 710, 708, 703, 712, 719, 697, 717, 706, 718, 714, 704, + 705, 709, 713, 702, 715, 716, 699 ] } ], @@ -19630,7 +20313,7 @@ { "title": "Properties", "kind": 1024, - "children": [638, 641, 640, 637, 636, 639, 642, 643] + "children": [659, 662, 661, 658, 657, 660, 663, 664] } ], "sources": [ @@ -19642,14 +20325,14 @@ ] }, { - "id": 718, + "id": 739, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 719, + "id": 740, "name": "id", "kind": 1024, "kindString": "Property", @@ -19670,7 +20353,7 @@ } }, { - "id": 720, + "id": 741, "name": "callback", "kind": 2048, "kindString": "Method", @@ -19684,7 +20367,7 @@ ], "signatures": [ { - "id": 721, + "id": 742, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -19694,17 +20377,17 @@ }, "parameters": [ { - "id": 722, + "id": 743, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 495, + "id": 516, "name": "AuthChangeEvent", "dereferenced": { - "id": 495, + "id": 516, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -19744,7 +20427,7 @@ "value": "USER_UPDATED" }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -19767,7 +20450,7 @@ } }, { - "id": 723, + "id": 744, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -19781,7 +20464,7 @@ }, { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } ] @@ -19796,7 +20479,7 @@ ] }, { - "id": 724, + "id": 745, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -19810,7 +20493,7 @@ ], "signatures": [ { - "id": 725, + "id": 746, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -19830,12 +20513,12 @@ { "title": "Properties", "kind": 1024, - "children": [719] + "children": [740] }, { "title": "Methods", "kind": 2048, - "children": [720, 724] + "children": [741, 745] } ], "sources": [ @@ -19847,14 +20530,14 @@ ] }, { - "id": 675, + "id": 696, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 686, + "id": 707, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -19874,7 +20557,7 @@ } }, { - "id": 677, + "id": 698, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -19888,17 +20571,17 @@ ], "type": { "type": "reference", - "id": 668, + "id": 689, "name": "UserAppMetadata", "dereferenced": { - "id": 668, + "id": 689, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 669, + "id": 690, "name": "provider", "kind": 1024, "kindString": "Property", @@ -19922,7 +20605,7 @@ { "title": "Properties", "kind": 1024, - "children": [669] + "children": [690] } ], "sources": [ @@ -19933,14 +20616,14 @@ } ], "indexSignature": { - "id": 670, + "id": 691, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 692, "name": "key", "kind": 32768, "flags": {}, @@ -19959,7 +20642,7 @@ } }, { - "id": 679, + "id": 700, "name": "aud", "kind": 1024, "kindString": "Property", @@ -19977,7 +20660,7 @@ } }, { - "id": 680, + "id": 701, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -19997,7 +20680,7 @@ } }, { - "id": 690, + "id": 711, "name": "confirmed_at", "kind": 1024, "kindString": "Property", @@ -20017,7 +20700,7 @@ } }, { - "id": 689, + "id": 710, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -20035,7 +20718,7 @@ } }, { - "id": 687, + "id": 708, "name": "email", "kind": 1024, "kindString": "Property", @@ -20055,7 +20738,7 @@ } }, { - "id": 682, + "id": 703, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", @@ -20075,7 +20758,7 @@ } }, { - "id": 691, + "id": 712, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", @@ -20095,7 +20778,7 @@ } }, { - "id": 698, + "id": 719, "name": "factors", "kind": 1024, "kindString": "Property", @@ -20113,13 +20796,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 676, + "id": 697, "name": "id", "kind": 1024, "kindString": "Property", @@ -20137,7 +20820,7 @@ } }, { - "id": 696, + "id": 717, "name": "identities", "kind": 1024, "kindString": "Property", @@ -20155,13 +20838,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 648, + "id": 669, "name": "UserIdentity" } } }, { - "id": 685, + "id": 706, "name": "invited_at", "kind": 1024, "kindString": "Property", @@ -20181,7 +20864,7 @@ } }, { - "id": 697, + "id": 718, "name": "is_anonymous", "kind": 1024, "kindString": "Property", @@ -20201,7 +20884,7 @@ } }, { - "id": 693, + "id": 714, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -20221,7 +20904,7 @@ } }, { - "id": 683, + "id": 704, "name": "new_email", "kind": 1024, "kindString": "Property", @@ -20241,7 +20924,7 @@ } }, { - "id": 684, + "id": 705, "name": "new_phone", "kind": 1024, "kindString": "Property", @@ -20261,7 +20944,7 @@ } }, { - "id": 688, + "id": 709, "name": "phone", "kind": 1024, "kindString": "Property", @@ -20281,7 +20964,7 @@ } }, { - "id": 692, + "id": 713, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", @@ -20301,7 +20984,7 @@ } }, { - "id": 681, + "id": 702, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -20321,7 +21004,7 @@ } }, { - "id": 694, + "id": 715, "name": "role", "kind": 1024, "kindString": "Property", @@ -20341,7 +21024,7 @@ } }, { - "id": 695, + "id": 716, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -20361,7 +21044,7 @@ } }, { - "id": 678, + "id": 699, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -20375,10 +21058,10 @@ ], "type": { "type": "reference", - "id": 672, + "id": 693, "name": "UserMetadata", "dereferenced": { - "id": 672, + "id": 693, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -20391,14 +21074,14 @@ } ], "indexSignature": { - "id": 673, + "id": 694, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 674, + "id": 695, "name": "key", "kind": 32768, "flags": {}, @@ -20422,8 +21105,8 @@ "title": "Properties", "kind": 1024, "children": [ - 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, 684, - 688, 692, 681, 694, 695, 678 + 707, 698, 700, 701, 711, 710, 708, 703, 712, 719, 697, 717, 706, 718, 714, 704, 705, + 709, 713, 702, 715, 716, 699 ] } ], @@ -20436,14 +21119,14 @@ ] }, { - "id": 668, + "id": 689, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 669, + "id": 690, "name": "provider", "kind": 1024, "kindString": "Property", @@ -20467,7 +21150,7 @@ { "title": "Properties", "kind": 1024, - "children": [669] + "children": [690] } ], "sources": [ @@ -20478,14 +21161,14 @@ } ], "indexSignature": { - "id": 670, + "id": 691, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 692, "name": "key", "kind": 32768, "flags": {}, @@ -20502,14 +21185,14 @@ } }, { - "id": 699, + "id": 720, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 704, + "id": 725, "name": "data", "kind": 1024, "kindString": "Property", @@ -20533,7 +21216,7 @@ } }, { - "id": 700, + "id": 721, "name": "email", "kind": 1024, "kindString": "Property", @@ -20556,7 +21239,7 @@ } }, { - "id": 703, + "id": 724, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -20580,7 +21263,7 @@ } }, { - "id": 702, + "id": 723, "name": "password", "kind": 1024, "kindString": "Property", @@ -20603,7 +21286,7 @@ } }, { - "id": 701, + "id": 722, "name": "phone", "kind": 1024, "kindString": "Property", @@ -20630,7 +21313,7 @@ { "title": "Properties", "kind": 1024, - "children": [704, 700, 703, 702, 701] + "children": [725, 721, 724, 723, 722] } ], "sources": [ @@ -20642,14 +21325,14 @@ ] }, { - "id": 648, + "id": 669, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 657, + "id": 678, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -20669,7 +21352,7 @@ } }, { - "id": 649, + "id": 670, "name": "id", "kind": 1024, "kindString": "Property", @@ -20687,7 +21370,7 @@ } }, { - "id": 651, + "id": 672, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -20704,20 +21387,20 @@ "type": { "type": "reflection", "declaration": { - "id": 652, + "id": 673, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 653, + "id": 674, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 654, + "id": 675, "name": "key", "kind": 32768, "flags": {}, @@ -20736,7 +21419,7 @@ } }, { - "id": 655, + "id": 676, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -20754,7 +21437,7 @@ } }, { - "id": 658, + "id": 679, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -20774,7 +21457,7 @@ } }, { - "id": 656, + "id": 677, "name": "provider", "kind": 1024, "kindString": "Property", @@ -20792,7 +21475,7 @@ } }, { - "id": 659, + "id": 680, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -20812,7 +21495,7 @@ } }, { - "id": 650, + "id": 671, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -20834,7 +21517,7 @@ { "title": "Properties", "kind": 1024, - "children": [657, 649, 651, 655, 658, 656, 659, 650] + "children": [678, 670, 672, 676, 679, 677, 680, 671] } ], "sources": [ @@ -20846,7 +21529,7 @@ ] }, { - "id": 672, + "id": 693, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -20859,14 +21542,14 @@ } ], "indexSignature": { - "id": 673, + "id": 694, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 674, + "id": 695, "name": "key", "kind": 32768, "flags": {}, @@ -20883,14 +21566,14 @@ } }, { - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 812, + "id": 833, "name": "email", "kind": 1024, "kindString": "Property", @@ -20911,7 +21594,7 @@ } }, { - "id": 815, + "id": 836, "name": "options", "kind": 1024, "kindString": "Property", @@ -20928,14 +21611,14 @@ "type": { "type": "reflection", "declaration": { - "id": 816, + "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 818, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20964,7 +21647,7 @@ } }, { - "id": 817, + "id": 838, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -20991,14 +21674,14 @@ { "title": "Properties", "kind": 1024, - "children": [818, 817] + "children": [839, 838] } ] } } }, { - "id": 813, + "id": 834, "name": "token", "kind": 1024, "kindString": "Property", @@ -21019,7 +21702,7 @@ } }, { - "id": 814, + "id": 835, "name": "type", "kind": 1024, "kindString": "Property", @@ -21036,10 +21719,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -21088,7 +21771,7 @@ { "title": "Properties", "kind": 1024, - "children": [812, 815, 813, 814] + "children": [833, 836, 834, 835] } ], "sources": [ @@ -21100,14 +21783,14 @@ ] }, { - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -21124,14 +21807,14 @@ "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21160,7 +21843,7 @@ } }, { - "id": 809, + "id": 830, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -21187,14 +21870,14 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ] } } }, { - "id": 804, + "id": 825, "name": "phone", "kind": 1024, "kindString": "Property", @@ -21215,7 +21898,7 @@ } }, { - "id": 805, + "id": 826, "name": "token", "kind": 1024, "kindString": "Property", @@ -21236,7 +21919,7 @@ } }, { - "id": 806, + "id": 827, "name": "type", "kind": 1024, "kindString": "Property", @@ -21253,10 +21936,10 @@ ], "type": { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType", "dereferenced": { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -21289,7 +21972,7 @@ { "title": "Properties", "kind": 1024, - "children": [807, 804, 805, 806] + "children": [828, 825, 826, 827] } ], "sources": [ @@ -21301,14 +21984,14 @@ ] }, { - "id": 819, + "id": 840, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -21329,7 +22012,7 @@ } }, { - "id": 821, + "id": 842, "name": "type", "kind": 1024, "kindString": "Property", @@ -21346,10 +22029,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -21398,7 +22081,7 @@ { "title": "Properties", "kind": 1024, - "children": [820, 821] + "children": [841, 842] } ], "sources": [ @@ -21410,7 +22093,7 @@ ] }, { - "id": 495, + "id": 516, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -21450,7 +22133,7 @@ "value": "USER_UPDATED" }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -21471,7 +22154,7 @@ } }, { - "id": 494, + "id": 515, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -21489,7 +22172,7 @@ } }, { - "id": 779, + "id": 800, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -21516,7 +22199,7 @@ } }, { - "id": 1005, + "id": 1026, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -21539,14 +22222,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1006, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1028, "name": "id", "kind": 1024, "kindString": "Property", @@ -21567,7 +22250,7 @@ } }, { - "id": 1008, + "id": 1029, "name": "userId", "kind": 1024, "kindString": "Property", @@ -21592,7 +22275,7 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1028, 1029] } ], "sources": [ @@ -21606,7 +22289,7 @@ } }, { - "id": 996, + "id": 1017, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", @@ -21632,14 +22315,14 @@ { "type": "reflection", "declaration": { - "id": 997, + "id": 1018, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1019, "name": "data", "kind": 1024, "kindString": "Property", @@ -21654,14 +22337,14 @@ "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1000, + "id": 1021, "name": "id", "kind": 1024, "kindString": "Property", @@ -21686,7 +22369,7 @@ { "title": "Properties", "kind": 1024, - "children": [1000] + "children": [1021] } ], "sources": [ @@ -21700,7 +22383,7 @@ } }, { - "id": 1001, + "id": 1022, "name": "error", "kind": 1024, "kindString": "Property", @@ -21722,7 +22405,7 @@ { "title": "Properties", "kind": 1024, - "children": [998, 1001] + "children": [1019, 1022] } ], "sources": [ @@ -21737,14 +22420,14 @@ { "type": "reflection", "declaration": { - "id": 1002, + "id": 1023, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1003, + "id": 1024, "name": "data", "kind": 1024, "kindString": "Property", @@ -21762,7 +22445,7 @@ } }, { - "id": 1004, + "id": 1025, "name": "error", "kind": 1024, "kindString": "Property", @@ -21776,7 +22459,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -21785,7 +22468,7 @@ { "title": "Properties", "kind": 1024, - "children": [1003, 1004] + "children": [1024, 1025] } ], "sources": [ @@ -21801,7 +22484,7 @@ } }, { - "id": 1018, + "id": 1039, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -21824,14 +22507,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1019, + "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1020, + "id": 1041, "name": "userId", "kind": 1024, "kindString": "Property", @@ -21856,7 +22539,7 @@ { "title": "Properties", "kind": 1024, - "children": [1020] + "children": [1041] } ], "sources": [ @@ -21870,7 +22553,7 @@ } }, { - "id": 1009, + "id": 1030, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -21896,14 +22579,14 @@ { "type": "reflection", "declaration": { - "id": 1010, + "id": 1031, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1032, "name": "data", "kind": 1024, "kindString": "Property", @@ -21918,14 +22601,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1012, + "id": 1033, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1013, + "id": 1034, "name": "factors", "kind": 1024, "kindString": "Property", @@ -21944,7 +22627,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } @@ -21954,7 +22637,7 @@ { "title": "Properties", "kind": 1024, - "children": [1013] + "children": [1034] } ], "sources": [ @@ -21968,7 +22651,7 @@ } }, { - "id": 1014, + "id": 1035, "name": "error", "kind": 1024, "kindString": "Property", @@ -21990,7 +22673,7 @@ { "title": "Properties", "kind": 1024, - "children": [1011, 1014] + "children": [1032, 1035] } ], "sources": [ @@ -22005,14 +22688,14 @@ { "type": "reflection", "declaration": { - "id": 1015, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1016, + "id": 1037, "name": "data", "kind": 1024, "kindString": "Property", @@ -22030,7 +22713,7 @@ } }, { - "id": 1017, + "id": 1038, "name": "error", "kind": 1024, "kindString": "Property", @@ -22044,7 +22727,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -22053,7 +22736,7 @@ { "title": "Properties", "kind": 1024, - "children": [1016, 1017] + "children": [1037, 1038] } ], "sources": [ @@ -22069,7 +22752,7 @@ } }, { - "id": 938, + "id": 959, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -22087,14 +22770,14 @@ { "type": "reflection", "declaration": { - "id": 939, + "id": 960, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 940, + "id": 961, "name": "data", "kind": 1024, "kindString": "Property", @@ -22109,14 +22792,14 @@ "type": { "type": "reflection", "declaration": { - "id": 941, + "id": 962, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 944, + "id": 965, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -22137,7 +22820,7 @@ } }, { - "id": 942, + "id": 963, "name": "id", "kind": 1024, "kindString": "Property", @@ -22158,7 +22841,7 @@ } }, { - "id": 943, + "id": 964, "name": "type", "kind": 1024, "kindString": "Property", @@ -22192,7 +22875,7 @@ { "title": "Properties", "kind": 1024, - "children": [944, 942, 943] + "children": [965, 963, 964] } ], "sources": [ @@ -22206,7 +22889,7 @@ } }, { - "id": 945, + "id": 966, "name": "error", "kind": 1024, "kindString": "Property", @@ -22228,7 +22911,7 @@ { "title": "Properties", "kind": 1024, - "children": [940, 945] + "children": [961, 966] } ], "sources": [ @@ -22243,14 +22926,14 @@ { "type": "reflection", "declaration": { - "id": 946, + "id": 967, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 947, + "id": 968, "name": "data", "kind": 1024, "kindString": "Property", @@ -22268,7 +22951,7 @@ } }, { - "id": 948, + "id": 969, "name": "error", "kind": 1024, "kindString": "Property", @@ -22282,7 +22965,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -22291,7 +22974,7 @@ { "title": "Properties", "kind": 1024, - "children": [947, 948] + "children": [968, 969] } ], "sources": [ @@ -22307,7 +22990,7 @@ } }, { - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -22325,14 +23008,14 @@ { "type": "reflection", "declaration": { - "id": 1082, + "id": 1103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1083, + "id": 1104, "name": "data", "kind": 1024, "kindString": "Property", @@ -22347,14 +23030,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1084, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1087, + "id": 1108, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -22377,7 +23060,7 @@ } }, { - "id": 1085, + "id": 1106, "name": "id", "kind": 1024, "kindString": "Property", @@ -22398,7 +23081,7 @@ } }, { - "id": 1088, + "id": 1109, "name": "phone", "kind": 1024, "kindString": "Property", @@ -22419,7 +23102,7 @@ } }, { - "id": 1086, + "id": 1107, "name": "type", "kind": 1024, "kindString": "Property", @@ -22444,7 +23127,7 @@ { "title": "Properties", "kind": 1024, - "children": [1087, 1085, 1088, 1086] + "children": [1108, 1106, 1109, 1107] } ], "sources": [ @@ -22458,7 +23141,7 @@ } }, { - "id": 1089, + "id": 1110, "name": "error", "kind": 1024, "kindString": "Property", @@ -22480,7 +23163,7 @@ { "title": "Properties", "kind": 1024, - "children": [1083, 1089] + "children": [1104, 1110] } ], "sources": [ @@ -22495,14 +23178,14 @@ { "type": "reflection", "declaration": { - "id": 1090, + "id": 1111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1091, + "id": 1112, "name": "data", "kind": 1024, "kindString": "Property", @@ -22520,7 +23203,7 @@ } }, { - "id": 1092, + "id": 1113, "name": "error", "kind": 1024, "kindString": "Property", @@ -22534,7 +23217,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -22543,7 +23226,7 @@ { "title": "Properties", "kind": 1024, - "children": [1091, 1092] + "children": [1112, 1113] } ], "sources": [ @@ -22559,7 +23242,7 @@ } }, { - "id": 928, + "id": 949, "name": "AuthMFAEnrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -22575,7 +23258,7 @@ "type": "union", "types": [ { - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -22593,14 +23276,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1087, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1088, "name": "data", "kind": 1024, "kindString": "Property", @@ -22615,14 +23298,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1068, + "id": 1089, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1076, + "id": 1097, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -22645,7 +23328,7 @@ } }, { - "id": 1069, + "id": 1090, "name": "id", "kind": 1024, "kindString": "Property", @@ -22666,7 +23349,7 @@ } }, { - "id": 1071, + "id": 1092, "name": "totp", "kind": 1024, "kindString": "Property", @@ -22684,14 +23367,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1073, + "id": 1094, "name": "qr_code", "kind": 1024, "kindString": "Property", @@ -22712,7 +23395,7 @@ } }, { - "id": 1074, + "id": 1095, "name": "secret", "kind": 1024, "kindString": "Property", @@ -22733,7 +23416,7 @@ } }, { - "id": 1075, + "id": 1096, "name": "uri", "kind": 1024, "kindString": "Property", @@ -22758,7 +23441,7 @@ { "title": "Properties", "kind": 1024, - "children": [1073, 1074, 1075] + "children": [1094, 1095, 1096] } ], "sources": [ @@ -22772,7 +23455,7 @@ } }, { - "id": 1070, + "id": 1091, "name": "type", "kind": 1024, "kindString": "Property", @@ -22797,7 +23480,7 @@ { "title": "Properties", "kind": 1024, - "children": [1076, 1069, 1071, 1070] + "children": [1097, 1090, 1092, 1091] } ], "sources": [ @@ -22811,7 +23494,7 @@ } }, { - "id": 1077, + "id": 1098, "name": "error", "kind": 1024, "kindString": "Property", @@ -22833,7 +23516,7 @@ { "title": "Properties", "kind": 1024, - "children": [1067, 1077] + "children": [1088, 1098] } ], "sources": [ @@ -22848,14 +23531,14 @@ { "type": "reflection", "declaration": { - "id": 1078, + "id": 1099, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1079, + "id": 1100, "name": "data", "kind": 1024, "kindString": "Property", @@ -22873,7 +23556,7 @@ } }, { - "id": 1080, + "id": 1101, "name": "error", "kind": 1024, "kindString": "Property", @@ -22887,7 +23570,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -22896,7 +23579,7 @@ { "title": "Properties", "kind": 1024, - "children": [1079, 1080] + "children": [1100, 1101] } ], "sources": [ @@ -22912,7 +23595,7 @@ } }, { - "id": 1081, + "id": 1102, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -22930,14 +23613,14 @@ { "type": "reflection", "declaration": { - "id": 1082, + "id": 1103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1083, + "id": 1104, "name": "data", "kind": 1024, "kindString": "Property", @@ -22952,14 +23635,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1084, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1087, + "id": 1108, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -22982,7 +23665,7 @@ } }, { - "id": 1085, + "id": 1106, "name": "id", "kind": 1024, "kindString": "Property", @@ -23003,7 +23686,7 @@ } }, { - "id": 1088, + "id": 1109, "name": "phone", "kind": 1024, "kindString": "Property", @@ -23024,7 +23707,7 @@ } }, { - "id": 1086, + "id": 1107, "name": "type", "kind": 1024, "kindString": "Property", @@ -23049,7 +23732,7 @@ { "title": "Properties", "kind": 1024, - "children": [1087, 1085, 1088, 1086] + "children": [1108, 1106, 1109, 1107] } ], "sources": [ @@ -23063,7 +23746,7 @@ } }, { - "id": 1089, + "id": 1110, "name": "error", "kind": 1024, "kindString": "Property", @@ -23085,7 +23768,7 @@ { "title": "Properties", "kind": 1024, - "children": [1083, 1089] + "children": [1104, 1110] } ], "sources": [ @@ -23100,14 +23783,14 @@ { "type": "reflection", "declaration": { - "id": 1090, + "id": 1111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1091, + "id": 1112, "name": "data", "kind": 1024, "kindString": "Property", @@ -23125,7 +23808,7 @@ } }, { - "id": 1092, + "id": 1113, "name": "error", "kind": 1024, "kindString": "Property", @@ -23139,7 +23822,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -23148,7 +23831,7 @@ { "title": "Properties", "kind": 1024, - "children": [1091, 1092] + "children": [1112, 1113] } ], "sources": [ @@ -23167,7 +23850,7 @@ } }, { - "id": 1065, + "id": 1086, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -23185,14 +23868,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1087, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1088, "name": "data", "kind": 1024, "kindString": "Property", @@ -23207,14 +23890,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1068, + "id": 1089, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1076, + "id": 1097, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -23237,7 +23920,7 @@ } }, { - "id": 1069, + "id": 1090, "name": "id", "kind": 1024, "kindString": "Property", @@ -23258,7 +23941,7 @@ } }, { - "id": 1071, + "id": 1092, "name": "totp", "kind": 1024, "kindString": "Property", @@ -23276,14 +23959,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1073, + "id": 1094, "name": "qr_code", "kind": 1024, "kindString": "Property", @@ -23304,7 +23987,7 @@ } }, { - "id": 1074, + "id": 1095, "name": "secret", "kind": 1024, "kindString": "Property", @@ -23325,7 +24008,7 @@ } }, { - "id": 1075, + "id": 1096, "name": "uri", "kind": 1024, "kindString": "Property", @@ -23350,7 +24033,7 @@ { "title": "Properties", "kind": 1024, - "children": [1073, 1074, 1075] + "children": [1094, 1095, 1096] } ], "sources": [ @@ -23364,7 +24047,7 @@ } }, { - "id": 1070, + "id": 1091, "name": "type", "kind": 1024, "kindString": "Property", @@ -23389,7 +24072,7 @@ { "title": "Properties", "kind": 1024, - "children": [1076, 1069, 1071, 1070] + "children": [1097, 1090, 1092, 1091] } ], "sources": [ @@ -23403,7 +24086,7 @@ } }, { - "id": 1077, + "id": 1098, "name": "error", "kind": 1024, "kindString": "Property", @@ -23425,7 +24108,7 @@ { "title": "Properties", "kind": 1024, - "children": [1067, 1077] + "children": [1088, 1098] } ], "sources": [ @@ -23440,14 +24123,14 @@ { "type": "reflection", "declaration": { - "id": 1078, + "id": 1099, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1079, + "id": 1100, "name": "data", "kind": 1024, "kindString": "Property", @@ -23465,7 +24148,7 @@ } }, { - "id": 1080, + "id": 1101, "name": "error", "kind": 1024, "kindString": "Property", @@ -23479,7 +24162,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -23488,7 +24171,7 @@ { "title": "Properties", "kind": 1024, - "children": [1079, 1080] + "children": [1100, 1101] } ], "sources": [ @@ -23504,7 +24187,7 @@ } }, { - "id": 961, + "id": 982, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -23522,14 +24205,14 @@ { "type": "reflection", "declaration": { - "id": 962, + "id": 983, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 963, + "id": 984, "name": "data", "kind": 1024, "kindString": "Property", @@ -23544,14 +24227,14 @@ "type": { "type": "reflection", "declaration": { - "id": 964, + "id": 985, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 967, + "id": 988, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", @@ -23570,13 +24253,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 644, + "id": 665, "name": "AMREntry" } } }, { - "id": 965, + "id": 986, "name": "currentLevel", "kind": 1024, "kindString": "Property", @@ -23596,7 +24279,7 @@ "types": [ { "type": "reference", - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels" }, { @@ -23607,7 +24290,7 @@ } }, { - "id": 966, + "id": 987, "name": "nextLevel", "kind": 1024, "kindString": "Property", @@ -23633,7 +24316,7 @@ "types": [ { "type": "reference", - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels" }, { @@ -23648,7 +24331,7 @@ { "title": "Properties", "kind": 1024, - "children": [967, 965, 966] + "children": [988, 986, 987] } ], "sources": [ @@ -23662,7 +24345,7 @@ } }, { - "id": 968, + "id": 989, "name": "error", "kind": 1024, "kindString": "Property", @@ -23684,7 +24367,7 @@ { "title": "Properties", "kind": 1024, - "children": [963, 968] + "children": [984, 989] } ], "sources": [ @@ -23699,14 +24382,14 @@ { "type": "reflection", "declaration": { - "id": 969, + "id": 990, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 970, + "id": 991, "name": "data", "kind": 1024, "kindString": "Property", @@ -23724,7 +24407,7 @@ } }, { - "id": 971, + "id": 992, "name": "error", "kind": 1024, "kindString": "Property", @@ -23738,7 +24421,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -23747,7 +24430,7 @@ { "title": "Properties", "kind": 1024, - "children": [970, 971] + "children": [991, 992] } ], "sources": [ @@ -23763,7 +24446,7 @@ } }, { - "id": 949, + "id": 970, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -23781,14 +24464,14 @@ { "type": "reflection", "declaration": { - "id": 950, + "id": 971, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 951, + "id": 972, "name": "data", "kind": 1024, "kindString": "Property", @@ -23803,14 +24486,14 @@ "type": { "type": "reflection", "declaration": { - "id": 952, + "id": 973, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 953, + "id": 974, "name": "all", "kind": 1024, "kindString": "Property", @@ -23829,13 +24512,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 955, + "id": 976, "name": "phone", "kind": 1024, "kindString": "Property", @@ -23854,13 +24537,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } }, { - "id": 954, + "id": 975, "name": "totp", "kind": 1024, "kindString": "Property", @@ -23879,7 +24562,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 660, + "id": 681, "name": "Factor" } } @@ -23889,7 +24572,7 @@ { "title": "Properties", "kind": 1024, - "children": [953, 955, 954] + "children": [974, 976, 975] } ], "sources": [ @@ -23903,7 +24586,7 @@ } }, { - "id": 956, + "id": 977, "name": "error", "kind": 1024, "kindString": "Property", @@ -23925,7 +24608,7 @@ { "title": "Properties", "kind": 1024, - "children": [951, 956] + "children": [972, 977] } ], "sources": [ @@ -23940,14 +24623,14 @@ { "type": "reflection", "declaration": { - "id": 957, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 979, "name": "data", "kind": 1024, "kindString": "Property", @@ -23965,7 +24648,7 @@ } }, { - "id": 959, + "id": 980, "name": "error", "kind": 1024, "kindString": "Property", @@ -23979,7 +24662,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -23988,7 +24671,7 @@ { "title": "Properties", "kind": 1024, - "children": [958, 959] + "children": [979, 980] } ], "sources": [ @@ -24004,7 +24687,7 @@ } }, { - "id": 929, + "id": 950, "name": "AuthMFAUnenrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -24022,14 +24705,14 @@ { "type": "reflection", "declaration": { - "id": 930, + "id": 951, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 952, "name": "data", "kind": 1024, "kindString": "Property", @@ -24044,14 +24727,14 @@ "type": { "type": "reflection", "declaration": { - "id": 932, + "id": 953, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 933, + "id": 954, "name": "id", "kind": 1024, "kindString": "Property", @@ -24076,7 +24759,7 @@ { "title": "Properties", "kind": 1024, - "children": [933] + "children": [954] } ], "sources": [ @@ -24090,7 +24773,7 @@ } }, { - "id": 934, + "id": 955, "name": "error", "kind": 1024, "kindString": "Property", @@ -24112,7 +24795,7 @@ { "title": "Properties", "kind": 1024, - "children": [931, 934] + "children": [952, 955] } ], "sources": [ @@ -24127,14 +24810,14 @@ { "type": "reflection", "declaration": { - "id": 935, + "id": 956, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 936, + "id": 957, "name": "data", "kind": 1024, "kindString": "Property", @@ -24152,7 +24835,7 @@ } }, { - "id": 937, + "id": 958, "name": "error", "kind": 1024, "kindString": "Property", @@ -24166,7 +24849,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -24175,7 +24858,7 @@ { "title": "Properties", "kind": 1024, - "children": [936, 937] + "children": [957, 958] } ], "sources": [ @@ -24191,7 +24874,7 @@ } }, { - "id": 915, + "id": 936, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -24209,14 +24892,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 937, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 938, "name": "data", "kind": 1024, "kindString": "Property", @@ -24231,14 +24914,14 @@ "type": { "type": "reflection", "declaration": { - "id": 918, + "id": 939, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 919, + "id": 940, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -24259,7 +24942,7 @@ } }, { - "id": 921, + "id": 942, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -24280,7 +24963,7 @@ } }, { - "id": 922, + "id": 943, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -24301,7 +24984,7 @@ } }, { - "id": 920, + "id": 941, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -24322,7 +25005,7 @@ } }, { - "id": 923, + "id": 944, "name": "user", "kind": 1024, "kindString": "Property", @@ -24339,7 +25022,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -24348,7 +25031,7 @@ { "title": "Properties", "kind": 1024, - "children": [919, 921, 922, 920, 923] + "children": [940, 942, 943, 941, 944] } ], "sources": [ @@ -24362,7 +25045,7 @@ } }, { - "id": 924, + "id": 945, "name": "error", "kind": 1024, "kindString": "Property", @@ -24384,7 +25067,7 @@ { "title": "Properties", "kind": 1024, - "children": [917, 924] + "children": [938, 945] } ], "sources": [ @@ -24399,14 +25082,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 946, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 947, "name": "data", "kind": 1024, "kindString": "Property", @@ -24424,7 +25107,7 @@ } }, { - "id": 927, + "id": 948, "name": "error", "kind": 1024, "kindString": "Property", @@ -24438,7 +25121,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -24447,7 +25130,7 @@ { "title": "Properties", "kind": 1024, - "children": [926, 927] + "children": [947, 948] } ], "sources": [ @@ -24463,7 +25146,7 @@ } }, { - "id": 559, + "id": 580, "name": "AuthOtpResponse", "kind": 4194304, "kindString": "Type alias", @@ -24485,14 +25168,14 @@ { "type": "reflection", "declaration": { - "id": 560, + "id": 581, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 561, + "id": 582, "name": "data", "kind": 1024, "kindString": "Property", @@ -24507,14 +25190,14 @@ "type": { "type": "reflection", "declaration": { - "id": 562, + "id": 583, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 565, + "id": 586, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -24543,7 +25226,7 @@ } }, { - "id": 564, + "id": 585, "name": "session", "kind": 1024, "kindString": "Property", @@ -24561,7 +25244,7 @@ } }, { - "id": 563, + "id": 584, "name": "user", "kind": 1024, "kindString": "Property", @@ -24583,7 +25266,7 @@ { "title": "Properties", "kind": 1024, - "children": [565, 564, 563] + "children": [586, 585, 584] } ], "sources": [ @@ -24597,7 +25280,7 @@ } }, { - "id": 566, + "id": 587, "name": "error", "kind": 1024, "kindString": "Property", @@ -24619,7 +25302,7 @@ { "title": "Properties", "kind": 1024, - "children": [561, 566] + "children": [582, 587] } ], "sources": [ @@ -24634,14 +25317,14 @@ { "type": "reflection", "declaration": { - "id": 567, + "id": 588, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 589, "name": "data", "kind": 1024, "kindString": "Property", @@ -24656,14 +25339,14 @@ "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 590, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 572, + "id": 593, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -24692,7 +25375,7 @@ } }, { - "id": 571, + "id": 592, "name": "session", "kind": 1024, "kindString": "Property", @@ -24710,7 +25393,7 @@ } }, { - "id": 570, + "id": 591, "name": "user", "kind": 1024, "kindString": "Property", @@ -24732,7 +25415,7 @@ { "title": "Properties", "kind": 1024, - "children": [572, 571, 570] + "children": [593, 592, 591] } ], "sources": [ @@ -24746,7 +25429,7 @@ } }, { - "id": 573, + "id": 594, "name": "error", "kind": 1024, "kindString": "Property", @@ -24760,7 +25443,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -24769,7 +25452,7 @@ { "title": "Properties", "kind": 1024, - "children": [568, 573] + "children": [589, 594] } ], "sources": [ @@ -24785,7 +25468,7 @@ } }, { - "id": 532, + "id": 553, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -24803,14 +25486,14 @@ { "type": "reflection", "declaration": { - "id": 533, + "id": 554, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 534, + "id": 555, "name": "data", "kind": 1024, "kindString": "Property", @@ -24825,14 +25508,14 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 537, + "id": 558, "name": "session", "kind": 1024, "kindString": "Property", @@ -24849,7 +25532,7 @@ "types": [ { "type": "reference", - "id": 635, + "id": 656, "name": "Session" }, { @@ -24860,7 +25543,7 @@ } }, { - "id": 536, + "id": 557, "name": "user", "kind": 1024, "kindString": "Property", @@ -24877,7 +25560,7 @@ "types": [ { "type": "reference", - "id": 675, + "id": 696, "name": "User" }, { @@ -24892,7 +25575,7 @@ { "title": "Properties", "kind": 1024, - "children": [537, 536] + "children": [558, 557] } ], "sources": [ @@ -24906,7 +25589,7 @@ } }, { - "id": 538, + "id": 559, "name": "error", "kind": 1024, "kindString": "Property", @@ -24928,7 +25611,7 @@ { "title": "Properties", "kind": 1024, - "children": [534, 538] + "children": [555, 559] } ], "sources": [ @@ -24943,14 +25626,14 @@ { "type": "reflection", "declaration": { - "id": 539, + "id": 560, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 540, + "id": 561, "name": "data", "kind": 1024, "kindString": "Property", @@ -24965,14 +25648,14 @@ "type": { "type": "reflection", "declaration": { - "id": 541, + "id": 562, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 543, + "id": 564, "name": "session", "kind": 1024, "kindString": "Property", @@ -24990,7 +25673,7 @@ } }, { - "id": 542, + "id": 563, "name": "user", "kind": 1024, "kindString": "Property", @@ -25012,7 +25695,7 @@ { "title": "Properties", "kind": 1024, - "children": [543, 542] + "children": [564, 563] } ], "sources": [ @@ -25026,7 +25709,7 @@ } }, { - "id": 544, + "id": 565, "name": "error", "kind": 1024, "kindString": "Property", @@ -25040,7 +25723,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -25049,7 +25732,7 @@ { "title": "Properties", "kind": 1024, - "children": [540, 544] + "children": [561, 565] } ], "sources": [ @@ -25065,7 +25748,7 @@ } }, { - "id": 545, + "id": 566, "name": "AuthResponsePassword", "kind": 4194304, "kindString": "Type alias", @@ -25083,14 +25766,14 @@ { "type": "reflection", "declaration": { - "id": 546, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 547, + "id": 568, "name": "data", "kind": 1024, "kindString": "Property", @@ -25105,14 +25788,14 @@ "type": { "type": "reflection", "declaration": { - "id": 548, + "id": 569, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 571, "name": "session", "kind": 1024, "kindString": "Property", @@ -25129,7 +25812,7 @@ "types": [ { "type": "reference", - "id": 635, + "id": 656, "name": "Session" }, { @@ -25140,7 +25823,7 @@ } }, { - "id": 549, + "id": 570, "name": "user", "kind": 1024, "kindString": "Property", @@ -25157,7 +25840,7 @@ "types": [ { "type": "reference", - "id": 675, + "id": 696, "name": "User" }, { @@ -25168,7 +25851,7 @@ } }, { - "id": 551, + "id": 572, "name": "weak_password", "kind": 1024, "kindString": "Property", @@ -25187,7 +25870,7 @@ "types": [ { "type": "reference", - "id": 528, + "id": 549, "name": "WeakPassword" }, { @@ -25202,7 +25885,7 @@ { "title": "Properties", "kind": 1024, - "children": [550, 549, 551] + "children": [571, 570, 572] } ], "sources": [ @@ -25216,7 +25899,7 @@ } }, { - "id": 552, + "id": 573, "name": "error", "kind": 1024, "kindString": "Property", @@ -25238,7 +25921,7 @@ { "title": "Properties", "kind": 1024, - "children": [547, 552] + "children": [568, 573] } ], "sources": [ @@ -25253,14 +25936,14 @@ { "type": "reflection", "declaration": { - "id": 553, + "id": 574, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 554, + "id": 575, "name": "data", "kind": 1024, "kindString": "Property", @@ -25275,14 +25958,14 @@ "type": { "type": "reflection", "declaration": { - "id": 555, + "id": 576, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 557, + "id": 578, "name": "session", "kind": 1024, "kindString": "Property", @@ -25300,7 +25983,7 @@ } }, { - "id": 556, + "id": 577, "name": "user", "kind": 1024, "kindString": "Property", @@ -25322,7 +26005,7 @@ { "title": "Properties", "kind": 1024, - "children": [557, 556] + "children": [578, 577] } ], "sources": [ @@ -25336,7 +26019,7 @@ } }, { - "id": 558, + "id": 579, "name": "error", "kind": 1024, "kindString": "Property", @@ -25350,7 +26033,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -25359,7 +26042,7 @@ { "title": "Properties", "kind": 1024, - "children": [554, 558] + "children": [575, 579] } ], "sources": [ @@ -25375,7 +26058,7 @@ } }, { - "id": 574, + "id": 595, "name": "AuthTokenResponse", "kind": 4194304, "kindString": "Type alias", @@ -25393,14 +26076,14 @@ { "type": "reflection", "declaration": { - "id": 575, + "id": 596, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 576, + "id": 597, "name": "data", "kind": 1024, "kindString": "Property", @@ -25415,14 +26098,14 @@ "type": { "type": "reflection", "declaration": { - "id": 577, + "id": 598, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 579, + "id": 600, "name": "session", "kind": 1024, "kindString": "Property", @@ -25436,12 +26119,12 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } }, { - "id": 578, + "id": 599, "name": "user", "kind": 1024, "kindString": "Property", @@ -25455,7 +26138,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -25464,7 +26147,7 @@ { "title": "Properties", "kind": 1024, - "children": [579, 578] + "children": [600, 599] } ], "sources": [ @@ -25478,7 +26161,7 @@ } }, { - "id": 580, + "id": 601, "name": "error", "kind": 1024, "kindString": "Property", @@ -25500,7 +26183,7 @@ { "title": "Properties", "kind": 1024, - "children": [576, 580] + "children": [597, 601] } ], "sources": [ @@ -25515,14 +26198,14 @@ { "type": "reflection", "declaration": { - "id": 581, + "id": 602, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 603, "name": "data", "kind": 1024, "kindString": "Property", @@ -25537,14 +26220,14 @@ "type": { "type": "reflection", "declaration": { - "id": 583, + "id": 604, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 585, + "id": 606, "name": "session", "kind": 1024, "kindString": "Property", @@ -25562,7 +26245,7 @@ } }, { - "id": 584, + "id": 605, "name": "user", "kind": 1024, "kindString": "Property", @@ -25584,7 +26267,7 @@ { "title": "Properties", "kind": 1024, - "children": [585, 584] + "children": [606, 605] } ], "sources": [ @@ -25598,7 +26281,7 @@ } }, { - "id": 586, + "id": 607, "name": "error", "kind": 1024, "kindString": "Property", @@ -25612,7 +26295,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -25621,7 +26304,7 @@ { "title": "Properties", "kind": 1024, - "children": [582, 586] + "children": [603, 607] } ], "sources": [ @@ -25637,7 +26320,7 @@ } }, { - "id": 587, + "id": 608, "name": "AuthTokenResponsePassword", "kind": 4194304, "kindString": "Type alias", @@ -25655,14 +26338,14 @@ { "type": "reflection", "declaration": { - "id": 588, + "id": 609, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 589, + "id": 610, "name": "data", "kind": 1024, "kindString": "Property", @@ -25677,14 +26360,14 @@ "type": { "type": "reflection", "declaration": { - "id": 590, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 592, + "id": 613, "name": "session", "kind": 1024, "kindString": "Property", @@ -25698,12 +26381,12 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } }, { - "id": 591, + "id": 612, "name": "user", "kind": 1024, "kindString": "Property", @@ -25717,12 +26400,12 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } }, { - "id": 593, + "id": 614, "name": "weakPassword", "kind": 1024, "kindString": "Property", @@ -25738,7 +26421,7 @@ ], "type": { "type": "reference", - "id": 528, + "id": 549, "name": "WeakPassword" } } @@ -25747,7 +26430,7 @@ { "title": "Properties", "kind": 1024, - "children": [592, 591, 593] + "children": [613, 612, 614] } ], "sources": [ @@ -25761,7 +26444,7 @@ } }, { - "id": 594, + "id": 615, "name": "error", "kind": 1024, "kindString": "Property", @@ -25783,7 +26466,7 @@ { "title": "Properties", "kind": 1024, - "children": [589, 594] + "children": [610, 615] } ], "sources": [ @@ -25798,14 +26481,14 @@ { "type": "reflection", "declaration": { - "id": 595, + "id": 616, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 596, + "id": 617, "name": "data", "kind": 1024, "kindString": "Property", @@ -25820,14 +26503,14 @@ "type": { "type": "reflection", "declaration": { - "id": 597, + "id": 618, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 599, + "id": 620, "name": "session", "kind": 1024, "kindString": "Property", @@ -25845,7 +26528,7 @@ } }, { - "id": 598, + "id": 619, "name": "user", "kind": 1024, "kindString": "Property", @@ -25863,7 +26546,7 @@ } }, { - "id": 600, + "id": 621, "name": "weakPassword", "kind": 1024, "kindString": "Property", @@ -25887,7 +26570,7 @@ { "title": "Properties", "kind": 1024, - "children": [599, 598, 600] + "children": [620, 619, 621] } ], "sources": [ @@ -25901,7 +26584,7 @@ } }, { - "id": 601, + "id": 622, "name": "error", "kind": 1024, "kindString": "Property", @@ -25915,7 +26598,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -25924,7 +26607,7 @@ { "title": "Properties", "kind": 1024, - "children": [596, 601] + "children": [617, 622] } ], "sources": [ @@ -25940,7 +26623,7 @@ } }, { - "id": 960, + "id": 981, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -25967,7 +26650,7 @@ } }, { - "id": 1034, + "id": 1055, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -25985,14 +26668,14 @@ { "type": "reflection", "declaration": { - "id": 1035, + "id": 1056, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1037, + "id": 1058, "name": "error", "kind": 1024, "kindString": "Property", @@ -26010,7 +26693,7 @@ } }, { - "id": 1036, + "id": 1057, "name": "session", "kind": 1024, "kindString": "Property", @@ -26024,7 +26707,7 @@ ], "type": { "type": "reference", - "id": 635, + "id": 656, "name": "Session" } } @@ -26033,7 +26716,7 @@ { "title": "Properties", "kind": 1024, - "children": [1037, 1036] + "children": [1058, 1057] } ], "sources": [ @@ -26048,14 +26731,14 @@ { "type": "reflection", "declaration": { - "id": 1038, + "id": 1059, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1040, + "id": 1061, "name": "error", "kind": 1024, "kindString": "Property", @@ -26069,12 +26752,12 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } }, { - "id": 1039, + "id": 1060, "name": "session", "kind": 1024, "kindString": "Property", @@ -26096,7 +26779,7 @@ { "title": "Properties", "kind": 1024, - "children": [1040, 1039] + "children": [1061, 1060] } ], "sources": [ @@ -26112,7 +26795,7 @@ } }, { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -26155,7 +26838,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26170,14 +26853,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -26198,7 +26881,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -26219,7 +26902,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -26238,7 +26921,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -26252,7 +26935,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -26283,7 +26966,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -26297,7 +26980,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26312,14 +26995,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -26340,7 +27023,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -26359,7 +27042,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -26382,7 +27065,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -26413,7 +27096,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -26427,7 +27110,7 @@ } }, { - "id": 876, + "id": 897, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26443,7 +27126,7 @@ "type": "union", "types": [ { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26458,14 +27141,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -26483,7 +27166,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -26502,7 +27185,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -26525,7 +27208,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -26543,7 +27226,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -26565,7 +27248,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -26579,7 +27262,7 @@ } }, { - "id": 857, + "id": 878, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26594,14 +27277,14 @@ "type": { "type": "reflection", "declaration": { - "id": 858, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "email", "kind": 1024, "kindString": "Property", @@ -26622,7 +27305,7 @@ } }, { - "id": 861, + "id": 882, "name": "options", "kind": 1024, "kindString": "Property", @@ -26641,7 +27324,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -26664,7 +27347,7 @@ } }, { - "id": 859, + "id": 880, "name": "type", "kind": 1024, "kindString": "Property", @@ -26695,7 +27378,7 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861, 859] + "children": [881, 882, 880] } ], "sources": [ @@ -26709,7 +27392,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26724,14 +27407,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -26752,7 +27435,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -26771,7 +27454,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -26785,7 +27468,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -26807,7 +27490,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -26821,7 +27504,7 @@ } }, { - "id": 867, + "id": 888, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26836,14 +27519,14 @@ "type": { "type": "reflection", "declaration": { - "id": 868, + "id": 889, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 891, "name": "email", "kind": 1024, "kindString": "Property", @@ -26864,7 +27547,7 @@ } }, { - "id": 871, + "id": 892, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -26885,7 +27568,7 @@ } }, { - "id": 872, + "id": 893, "name": "options", "kind": 1024, "kindString": "Property", @@ -26904,7 +27587,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -26918,7 +27601,7 @@ } }, { - "id": 869, + "id": 890, "name": "type", "kind": 1024, "kindString": "Property", @@ -26949,7 +27632,7 @@ { "title": "Properties", "kind": 1024, - "children": [870, 871, 872, 869] + "children": [891, 892, 893, 890] } ], "sources": [ @@ -26966,7 +27649,7 @@ } }, { - "id": 890, + "id": 911, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -26984,14 +27667,14 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 913, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -27012,7 +27695,7 @@ } }, { - "id": 893, + "id": 914, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -27033,7 +27716,7 @@ } }, { - "id": 894, + "id": 915, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -27054,7 +27737,7 @@ } }, { - "id": 895, + "id": 916, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -27075,7 +27758,7 @@ } }, { - "id": 896, + "id": 917, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -27092,10 +27775,10 @@ ], "type": { "type": "reference", - "id": 897, + "id": 918, "name": "GenerateLinkType", "dereferenced": { - "id": 897, + "id": 918, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -27144,7 +27827,7 @@ { "title": "Properties", "kind": 1024, - "children": [892, 893, 894, 895, 896] + "children": [913, 914, 915, 916, 917] } ], "sources": [ @@ -27158,7 +27841,7 @@ } }, { - "id": 877, + "id": 898, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -27176,14 +27859,14 @@ { "type": "reflection", "declaration": { - "id": 878, + "id": 899, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 900, "name": "data", "kind": 1024, "kindString": "Property", @@ -27198,14 +27881,14 @@ "type": { "type": "reflection", "declaration": { - "id": 880, + "id": 901, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 881, + "id": 902, "name": "properties", "kind": 1024, "kindString": "Property", @@ -27219,12 +27902,12 @@ ], "type": { "type": "reference", - "id": 890, + "id": 911, "name": "GenerateLinkProperties" } }, { - "id": 882, + "id": 903, "name": "user", "kind": 1024, "kindString": "Property", @@ -27238,7 +27921,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -27247,7 +27930,7 @@ { "title": "Properties", "kind": 1024, - "children": [881, 882] + "children": [902, 903] } ], "sources": [ @@ -27261,7 +27944,7 @@ } }, { - "id": 883, + "id": 904, "name": "error", "kind": 1024, "kindString": "Property", @@ -27283,7 +27966,7 @@ { "title": "Properties", "kind": 1024, - "children": [879, 883] + "children": [900, 904] } ], "sources": [ @@ -27298,14 +27981,14 @@ { "type": "reflection", "declaration": { - "id": 884, + "id": 905, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 885, + "id": 906, "name": "data", "kind": 1024, "kindString": "Property", @@ -27320,14 +28003,14 @@ "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 907, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 887, + "id": 908, "name": "properties", "kind": 1024, "kindString": "Property", @@ -27345,7 +28028,7 @@ } }, { - "id": 888, + "id": 909, "name": "user", "kind": 1024, "kindString": "Property", @@ -27367,7 +28050,7 @@ { "title": "Properties", "kind": 1024, - "children": [887, 888] + "children": [908, 909] } ], "sources": [ @@ -27381,7 +28064,7 @@ } }, { - "id": 889, + "id": 910, "name": "error", "kind": 1024, "kindString": "Property", @@ -27395,7 +28078,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -27404,7 +28087,7 @@ { "title": "Properties", "kind": 1024, - "children": [885, 889] + "children": [906, 910] } ], "sources": [ @@ -27420,7 +28103,7 @@ } }, { - "id": 897, + "id": 918, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -27463,7 +28146,7 @@ } }, { - "id": 862, + "id": 883, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -27478,14 +28161,14 @@ "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 886, "name": "email", "kind": 1024, "kindString": "Property", @@ -27506,7 +28189,7 @@ } }, { - "id": 866, + "id": 887, "name": "options", "kind": 1024, "kindString": "Property", @@ -27525,7 +28208,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -27539,7 +28222,7 @@ } }, { - "id": 864, + "id": 885, "name": "type", "kind": 1024, "kindString": "Property", @@ -27561,7 +28244,7 @@ { "title": "Properties", "kind": 1024, - "children": [865, 866, 864] + "children": [886, 887, 885] } ], "sources": [ @@ -27575,7 +28258,7 @@ } }, { - "id": 851, + "id": 872, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -27590,14 +28273,14 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 854, + "id": 875, "name": "email", "kind": 1024, "kindString": "Property", @@ -27615,7 +28298,7 @@ } }, { - "id": 856, + "id": 877, "name": "options", "kind": 1024, "kindString": "Property", @@ -27634,7 +28317,7 @@ "typeArguments": [ { "type": "reference", - "id": 873, + "id": 894, "name": "GenerateLinkOptions" }, { @@ -27657,7 +28340,7 @@ } }, { - "id": 855, + "id": 876, "name": "password", "kind": 1024, "kindString": "Property", @@ -27675,7 +28358,7 @@ } }, { - "id": 853, + "id": 874, "name": "type", "kind": 1024, "kindString": "Property", @@ -27697,7 +28380,7 @@ { "title": "Properties", "kind": 1024, - "children": [854, 856, 855, 853] + "children": [875, 877, 876, 874] } ], "sources": [ @@ -27711,7 +28394,7 @@ } }, { - "id": 505, + "id": 526, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -27726,14 +28409,14 @@ "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 535, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -27753,7 +28436,7 @@ } }, { - "id": 519, + "id": 540, "name": "debug", "kind": 1024, "kindString": "Property", @@ -27777,7 +28460,7 @@ { "type": "reflection", "declaration": { - "id": 520, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -27791,14 +28474,14 @@ ], "signatures": [ { - "id": 521, + "id": 542, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 522, + "id": 543, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -27809,7 +28492,7 @@ } }, { - "id": 523, + "id": 544, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -27837,7 +28520,7 @@ } }, { - "id": 513, + "id": 534, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -27857,7 +28540,7 @@ } }, { - "id": 517, + "id": 538, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -27877,7 +28560,7 @@ } }, { - "id": 518, + "id": 539, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -27893,10 +28576,10 @@ ], "type": { "type": "reference", - "id": 779, + "id": 800, "name": "AuthFlowType", "dereferenced": { - "id": 779, + "id": 800, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -27925,7 +28608,7 @@ } }, { - "id": 525, + "id": 546, "name": "hasCustomAuthorizationHeader", "kind": 1024, "kindString": "Property", @@ -27954,7 +28637,7 @@ } }, { - "id": 508, + "id": 529, "name": "headers", "kind": 1024, "kindString": "Property", @@ -27971,7 +28654,7 @@ "type": { "type": "reflection", "declaration": { - "id": 509, + "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -27984,14 +28667,14 @@ } ], "indexSignature": { - "id": 510, + "id": 531, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 511, + "id": 532, "name": "key", "kind": 32768, "flags": {}, @@ -28010,7 +28693,7 @@ } }, { - "id": 524, + "id": 545, "name": "lock", "kind": 1024, "kindString": "Property", @@ -28035,10 +28718,10 @@ ], "type": { "type": "reference", - "id": 496, + "id": 517, "name": "LockFunc", "dereferenced": { - "id": 496, + "id": 517, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -28053,7 +28736,7 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -28067,7 +28750,7 @@ ], "signatures": [ { - "id": 498, + "id": 519, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -28083,7 +28766,7 @@ }, "typeParameter": [ { - "id": 504, + "id": 525, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -28092,7 +28775,7 @@ ], "parameters": [ { - "id": 499, + "id": 520, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -28106,7 +28789,7 @@ } }, { - "id": 500, + "id": 521, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -28120,7 +28803,7 @@ } }, { - "id": 501, + "id": 522, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -28131,7 +28814,7 @@ "type": { "type": "reflection", "declaration": { - "id": 502, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -28145,7 +28828,7 @@ ], "signatures": [ { - "id": 503, + "id": 524, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -28155,7 +28838,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -28174,7 +28857,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -28190,7 +28873,7 @@ } }, { - "id": 515, + "id": 536, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -28210,7 +28893,7 @@ } }, { - "id": 516, + "id": 537, "name": "storage", "kind": 1024, "kindString": "Property", @@ -28226,10 +28909,10 @@ ], "type": { "type": "reference", - "id": 1028, + "id": 1049, "name": "SupportedStorage", "dereferenced": { - "id": 1028, + "id": 1049, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -28284,14 +28967,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1050, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1030, + "id": 1051, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -28318,7 +29001,7 @@ { "title": "Properties", "kind": 1024, - "children": [1030] + "children": [1051] } ], "sources": [ @@ -28336,7 +29019,7 @@ } }, { - "id": 512, + "id": 533, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -28356,7 +29039,7 @@ } }, { - "id": 507, + "id": 528, "name": "url", "kind": 1024, "kindString": "Property", @@ -28380,7 +29063,7 @@ { "title": "Properties", "kind": 1024, - "children": [514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507] + "children": [535, 540, 534, 538, 539, 546, 529, 545, 536, 537, 533, 528] } ], "sources": [ @@ -28394,7 +29077,7 @@ } }, { - "id": 1031, + "id": 1052, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -28409,14 +29092,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1032, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1033, + "id": 1054, "name": "error", "kind": 1024, "kindString": "Property", @@ -28433,7 +29116,7 @@ "types": [ { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" }, { @@ -28448,7 +29131,7 @@ { "title": "Properties", "kind": 1024, - "children": [1033] + "children": [1054] } ], "sources": [ @@ -28462,7 +29145,178 @@ } }, { - "id": 496, + "id": 1114, + "name": "JwtHeader", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1203, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1115, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1116, + "name": "alg", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1204, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "RS256" + }, + { + "type": "literal", + "value": "ES256" + }, + { + "type": "literal", + "value": "HS256" + } + ] + } + }, + { + "id": 1117, + "name": "kid", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1205, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1118, + "name": "typ", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1206, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1116, 1117, 1118] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1203, + "character": 24 + } + ] + } + } + }, + { + "id": 1129, + "name": "JwtPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1220, + "character": 12 + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "id": 1119, + "name": "RequiredClaims" + }, + { + "type": "reflection", + "declaration": { + "id": 1130, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1220, + "character": 42 + } + ], + "indexSignature": { + "id": 1131, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 1132, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + ] + } + }, + { + "id": 517, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -28477,7 +29331,7 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -28491,7 +29345,7 @@ ], "signatures": [ { - "id": 498, + "id": 519, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -28507,7 +29361,7 @@ }, "typeParameter": [ { - "id": 504, + "id": 525, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -28516,7 +29370,7 @@ ], "parameters": [ { - "id": 499, + "id": 520, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -28530,7 +29384,7 @@ } }, { - "id": 500, + "id": 521, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -28544,7 +29398,7 @@ } }, { - "id": 501, + "id": 522, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -28555,7 +29409,7 @@ "type": { "type": "reflection", "declaration": { - "id": 502, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -28569,7 +29423,7 @@ ], "signatures": [ { - "id": 503, + "id": 524, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -28579,7 +29433,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -28598,7 +29452,7 @@ "typeArguments": [ { "type": "reference", - "id": 504, + "id": 525, "name": "R" } ], @@ -28612,7 +29466,7 @@ } }, { - "id": 911, + "id": 932, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -28627,14 +29481,14 @@ "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 933, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 914, + "id": 935, "name": "code", "kind": 1024, "kindString": "Property", @@ -28655,7 +29509,7 @@ } }, { - "id": 913, + "id": 934, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -28680,7 +29534,7 @@ { "title": "Properties", "kind": 1024, - "children": [914, 913] + "children": [935, 934] } ], "sources": [ @@ -28694,7 +29548,7 @@ } }, { - "id": 907, + "id": 928, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -28709,14 +29563,14 @@ "type": { "type": "reflection", "declaration": { - "id": 908, + "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 910, + "id": 931, "name": "channel", "kind": 1024, "kindString": "Property", @@ -28748,7 +29602,7 @@ } }, { - "id": 909, + "id": 930, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -28773,7 +29627,7 @@ { "title": "Properties", "kind": 1024, - "children": [910, 909] + "children": [931, 930] } ], "sources": [ @@ -28787,7 +29641,7 @@ } }, { - "id": 898, + "id": 919, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -28803,7 +29657,7 @@ "type": "union", "types": [ { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -28818,14 +29672,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -28846,7 +29700,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -28869,7 +29723,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -28896,7 +29750,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -28910,7 +29764,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -28925,14 +29779,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -28953,7 +29807,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -28976,7 +29830,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -29001,7 +29855,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -29018,7 +29872,7 @@ } }, { - "id": 1060, + "id": 1081, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -29033,14 +29887,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1061, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1083, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -29061,7 +29915,7 @@ } }, { - "id": 1063, + "id": 1084, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -29084,7 +29938,7 @@ } }, { - "id": 1064, + "id": 1085, "name": "phone", "kind": 1024, "kindString": "Property", @@ -29109,7 +29963,7 @@ { "title": "Properties", "kind": 1024, - "children": [1062, 1063, 1064] + "children": [1083, 1084, 1085] } ], "sources": [ @@ -29123,7 +29977,7 @@ } }, { - "id": 1055, + "id": 1076, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -29138,14 +29992,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1056, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1078, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -29166,7 +30020,7 @@ } }, { - "id": 1059, + "id": 1080, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -29189,7 +30043,7 @@ } }, { - "id": 1058, + "id": 1079, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -29216,7 +30070,7 @@ { "title": "Properties", "kind": 1024, - "children": [1057, 1059, 1058] + "children": [1078, 1080, 1079] } ], "sources": [ @@ -29230,7 +30084,7 @@ } }, { - "id": 899, + "id": 920, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -29245,14 +30099,14 @@ "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 922, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -29277,7 +30131,7 @@ { "title": "Properties", "kind": 1024, - "children": [901] + "children": [922] } ], "sources": [ @@ -29291,7 +30145,7 @@ } }, { - "id": 902, + "id": 923, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -29306,14 +30160,14 @@ "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 924, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 926, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -29334,7 +30188,7 @@ } }, { - "id": 906, + "id": 927, "name": "code", "kind": 1024, "kindString": "Property", @@ -29355,7 +30209,7 @@ } }, { - "id": 904, + "id": 925, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -29380,7 +30234,7 @@ { "title": "Properties", "kind": 1024, - "children": [905, 906, 904] + "children": [926, 927, 925] } ], "sources": [ @@ -29394,7 +30248,7 @@ } }, { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -29421,7 +30275,7 @@ } }, { - "id": 602, + "id": 623, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -29439,14 +30293,14 @@ { "type": "reflection", "declaration": { - "id": 603, + "id": 624, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 604, + "id": 625, "name": "data", "kind": 1024, "kindString": "Property", @@ -29461,14 +30315,14 @@ "type": { "type": "reflection", "declaration": { - "id": 605, + "id": 626, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 606, + "id": 627, "name": "provider", "kind": 1024, "kindString": "Property", @@ -29482,12 +30336,12 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider" } }, { - "id": 607, + "id": 628, "name": "url", "kind": 1024, "kindString": "Property", @@ -29509,7 +30363,7 @@ { "title": "Properties", "kind": 1024, - "children": [606, 607] + "children": [627, 628] } ], "sources": [ @@ -29523,7 +30377,7 @@ } }, { - "id": 608, + "id": 629, "name": "error", "kind": 1024, "kindString": "Property", @@ -29545,7 +30399,7 @@ { "title": "Properties", "kind": 1024, - "children": [604, 608] + "children": [625, 629] } ], "sources": [ @@ -29560,14 +30414,14 @@ { "type": "reflection", "declaration": { - "id": 609, + "id": 630, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 610, + "id": 631, "name": "data", "kind": 1024, "kindString": "Property", @@ -29582,14 +30436,14 @@ "type": { "type": "reflection", "declaration": { - "id": 611, + "id": 632, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 612, + "id": 633, "name": "provider", "kind": 1024, "kindString": "Property", @@ -29603,12 +30457,12 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider" } }, { - "id": 613, + "id": 634, "name": "url", "kind": 1024, "kindString": "Property", @@ -29630,7 +30484,7 @@ { "title": "Properties", "kind": 1024, - "children": [612, 613] + "children": [633, 634] } ], "sources": [ @@ -29644,7 +30498,7 @@ } }, { - "id": 614, + "id": 635, "name": "error", "kind": 1024, "kindString": "Property", @@ -29658,7 +30512,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -29667,7 +30521,7 @@ { "title": "Properties", "kind": 1024, - "children": [610, 614] + "children": [631, 635] } ], "sources": [ @@ -29683,7 +30537,7 @@ } }, { - "id": 1048, + "id": 1069, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -29698,14 +30552,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1070, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1071, "name": "page", "kind": 1024, "kindString": "Property", @@ -29728,7 +30582,7 @@ } }, { - "id": 1051, + "id": 1072, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -29755,7 +30609,7 @@ { "title": "Properties", "kind": 1024, - "children": [1050, 1051] + "children": [1071, 1072] } ], "sources": [ @@ -29769,7 +30623,7 @@ } }, { - "id": 1041, + "id": 1062, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -29784,14 +30638,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1042, + "id": 1063, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1044, + "id": 1065, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -29809,7 +30663,7 @@ } }, { - "id": 1043, + "id": 1064, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -29836,7 +30690,7 @@ } }, { - "id": 1045, + "id": 1066, "name": "total", "kind": 1024, "kindString": "Property", @@ -29858,7 +30712,7 @@ { "title": "Properties", "kind": 1024, - "children": [1044, 1043, 1045] + "children": [1065, 1064, 1066] } ], "sources": [ @@ -29869,14 +30723,14 @@ } ], "indexSignature": { - "id": 1046, + "id": 1067, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1047, + "id": 1068, "name": "key", "kind": 32768, "flags": {}, @@ -29895,7 +30749,7 @@ } }, { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -30005,7 +30859,231 @@ } }, { - "id": 824, + "id": 1119, + "name": "RequiredClaims", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1209, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1120, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1127, + "name": "aal", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1216, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 981, + "name": "AuthenticatorAssuranceLevels", + "dereferenced": { + "id": 981, + "name": "AuthenticatorAssuranceLevels", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 903, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "aal1" + }, + { + "type": "literal", + "value": "aal2" + } + ] + } + } + } + }, + { + "id": 1123, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1212, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1124, + "name": "exp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1213, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1125, + "name": "iat", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1214, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1121, + "name": "iss", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1126, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1215, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1128, + "name": "session_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1217, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1122, + "name": "sub", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1211, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1127, 1123, 1124, 1125, 1121, 1126, 1128, 1122] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1209, + "character": 29 + } + ] + } + } + }, + { + "id": 845, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -30023,14 +31101,14 @@ { "type": "reflection", "declaration": { - "id": 825, + "id": 846, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 827, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", @@ -30048,7 +31126,7 @@ } }, { - "id": 828, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -30065,14 +31143,14 @@ "type": { "type": "reflection", "declaration": { - "id": 829, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 831, + "id": 852, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30095,7 +31173,7 @@ } }, { - "id": 830, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -30122,7 +31200,7 @@ { "title": "Properties", "kind": 1024, - "children": [831, 830] + "children": [852, 851] } ], "sources": [ @@ -30136,7 +31214,7 @@ } }, { - "id": 826, + "id": 847, "name": "type", "kind": 1024, "kindString": "Property", @@ -30153,7 +31231,7 @@ "typeArguments": [ { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType" }, { @@ -30180,7 +31258,7 @@ { "title": "Properties", "kind": 1024, - "children": [827, 828, 826] + "children": [848, 849, 847] } ], "sources": [ @@ -30195,14 +31273,14 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 853, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -30219,14 +31297,14 @@ "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 857, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 858, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30253,7 +31331,7 @@ { "title": "Properties", "kind": 1024, - "children": [837] + "children": [858] } ], "sources": [ @@ -30267,7 +31345,7 @@ } }, { - "id": 834, + "id": 855, "name": "phone", "kind": 1024, "kindString": "Property", @@ -30285,7 +31363,7 @@ } }, { - "id": 833, + "id": 854, "name": "type", "kind": 1024, "kindString": "Property", @@ -30302,7 +31380,7 @@ "typeArguments": [ { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType" }, { @@ -30329,7 +31407,7 @@ { "title": "Properties", "kind": 1024, - "children": [835, 834, 833] + "children": [856, 855, 854] } ], "sources": [ @@ -30345,7 +31423,7 @@ } }, { - "id": 615, + "id": 636, "name": "SSOResponse", "kind": 4194304, "kindString": "Type alias", @@ -30363,14 +31441,14 @@ { "type": "reflection", "declaration": { - "id": 616, + "id": 637, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 638, "name": "data", "kind": 1024, "kindString": "Property", @@ -30385,14 +31463,14 @@ "type": { "type": "reflection", "declaration": { - "id": 618, + "id": 639, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 619, + "id": 640, "name": "url", "kind": 1024, "kindString": "Property", @@ -30418,7 +31496,7 @@ { "title": "Properties", "kind": 1024, - "children": [619] + "children": [640] } ], "sources": [ @@ -30432,7 +31510,7 @@ } }, { - "id": 620, + "id": 641, "name": "error", "kind": 1024, "kindString": "Property", @@ -30454,7 +31532,7 @@ { "title": "Properties", "kind": 1024, - "children": [617, 620] + "children": [638, 641] } ], "sources": [ @@ -30469,14 +31547,14 @@ { "type": "reflection", "declaration": { - "id": 621, + "id": 642, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 643, "name": "data", "kind": 1024, "kindString": "Property", @@ -30494,7 +31572,7 @@ } }, { - "id": 623, + "id": 644, "name": "error", "kind": 1024, "kindString": "Property", @@ -30508,7 +31586,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -30517,7 +31595,7 @@ { "title": "Properties", "kind": 1024, - "children": [622, 623] + "children": [643, 644] } ], "sources": [ @@ -30533,7 +31611,7 @@ } }, { - "id": 726, + "id": 747, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -30548,14 +31626,14 @@ "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 748, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 728, + "id": 749, "name": "options", "kind": 1024, "kindString": "Property", @@ -30572,14 +31650,14 @@ "type": { "type": "reflection", "declaration": { - "id": 729, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 752, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30602,7 +31680,7 @@ } }, { - "id": 730, + "id": 751, "name": "data", "kind": 1024, "kindString": "Property", @@ -30630,7 +31708,7 @@ { "title": "Properties", "kind": 1024, - "children": [731, 730] + "children": [752, 751] } ], "sources": [ @@ -30648,7 +31726,7 @@ { "title": "Properties", "kind": 1024, - "children": [728] + "children": [749] } ], "sources": [ @@ -30662,7 +31740,7 @@ } }, { - "id": 792, + "id": 813, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -30677,14 +31755,14 @@ "type": { "type": "reflection", "declaration": { - "id": 793, + "id": 814, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -30707,7 +31785,7 @@ } }, { - "id": 798, + "id": 819, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -30730,7 +31808,7 @@ } }, { - "id": 799, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -30747,14 +31825,14 @@ "type": { "type": "reflection", "declaration": { - "id": 800, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 801, + "id": 822, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30781,7 +31859,7 @@ { "title": "Properties", "kind": 1024, - "children": [801] + "children": [822] } ], "sources": [ @@ -30795,7 +31873,7 @@ } }, { - "id": 794, + "id": 815, "name": "provider", "kind": 1024, "kindString": "Property", @@ -30843,7 +31921,7 @@ { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -30863,7 +31941,7 @@ } }, { - "id": 796, + "id": 817, "name": "token", "kind": 1024, "kindString": "Property", @@ -30888,7 +31966,7 @@ { "title": "Properties", "kind": 1024, - "children": [797, 798, 799, 794, 796] + "children": [818, 819, 820, 815, 817] } ], "sources": [ @@ -30902,7 +31980,7 @@ } }, { - "id": 780, + "id": 801, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -30917,14 +31995,14 @@ "type": { "type": "reflection", "declaration": { - "id": 781, + "id": 802, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 783, + "id": 804, "name": "options", "kind": 1024, "kindString": "Property", @@ -30941,14 +32019,14 @@ "type": { "type": "reflection", "declaration": { - "id": 784, + "id": 805, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 787, + "id": 808, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -30968,7 +32046,7 @@ "type": { "type": "reflection", "declaration": { - "id": 788, + "id": 809, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -30981,14 +32059,14 @@ } ], "indexSignature": { - "id": 789, + "id": 810, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 790, + "id": 811, "name": "key", "kind": 32768, "flags": {}, @@ -31007,7 +32085,7 @@ } }, { - "id": 785, + "id": 806, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -31030,7 +32108,7 @@ } }, { - "id": 786, + "id": 807, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -31053,7 +32131,7 @@ } }, { - "id": 791, + "id": 812, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -31080,7 +32158,7 @@ { "title": "Properties", "kind": 1024, - "children": [787, 785, 786, 791] + "children": [808, 806, 807, 812] } ], "sources": [ @@ -31094,7 +32172,7 @@ } }, { - "id": 782, + "id": 803, "name": "provider", "kind": 1024, "kindString": "Property", @@ -31111,10 +32189,10 @@ ], "type": { "type": "reference", - "id": 493, + "id": 514, "name": "Provider", "dereferenced": { - "id": 493, + "id": 514, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -31230,7 +32308,7 @@ { "title": "Properties", "kind": 1024, - "children": [783, 782] + "children": [804, 803] } ], "sources": [ @@ -31244,7 +32322,7 @@ } }, { - "id": 749, + "id": 770, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -31262,14 +32340,14 @@ { "type": "reflection", "declaration": { - "id": 750, + "id": 771, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 751, + "id": 772, "name": "email", "kind": 1024, "kindString": "Property", @@ -31290,7 +32368,7 @@ } }, { - "id": 753, + "id": 774, "name": "options", "kind": 1024, "kindString": "Property", @@ -31307,14 +32385,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 775, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 755, + "id": 776, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -31341,7 +32419,7 @@ { "title": "Properties", "kind": 1024, - "children": [755] + "children": [776] } ], "sources": [ @@ -31355,7 +32433,7 @@ } }, { - "id": 752, + "id": 773, "name": "password", "kind": 1024, "kindString": "Property", @@ -31380,7 +32458,7 @@ { "title": "Properties", "kind": 1024, - "children": [751, 753, 752] + "children": [772, 774, 773] } ], "sources": [ @@ -31395,14 +32473,14 @@ { "type": "reflection", "declaration": { - "id": 756, + "id": 777, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 759, + "id": 780, "name": "options", "kind": 1024, "kindString": "Property", @@ -31419,14 +32497,14 @@ "type": { "type": "reflection", "declaration": { - "id": 760, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 782, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -31453,7 +32531,7 @@ { "title": "Properties", "kind": 1024, - "children": [761] + "children": [782] } ], "sources": [ @@ -31467,7 +32545,7 @@ } }, { - "id": 758, + "id": 779, "name": "password", "kind": 1024, "kindString": "Property", @@ -31488,7 +32566,7 @@ } }, { - "id": 757, + "id": 778, "name": "phone", "kind": 1024, "kindString": "Property", @@ -31513,7 +32591,7 @@ { "title": "Properties", "kind": 1024, - "children": [759, 758, 757] + "children": [780, 779, 778] } ], "sources": [ @@ -31529,7 +32607,7 @@ } }, { - "id": 762, + "id": 783, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -31547,14 +32625,14 @@ { "type": "reflection", "declaration": { - "id": 763, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 764, + "id": 785, "name": "email", "kind": 1024, "kindString": "Property", @@ -31575,7 +32653,7 @@ } }, { - "id": 765, + "id": 786, "name": "options", "kind": 1024, "kindString": "Property", @@ -31592,14 +32670,14 @@ "type": { "type": "reflection", "declaration": { - "id": 766, + "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 770, + "id": 791, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -31622,7 +32700,7 @@ } }, { - "id": 769, + "id": 790, "name": "data", "kind": 1024, "kindString": "Property", @@ -31646,7 +32724,7 @@ } }, { - "id": 767, + "id": 788, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -31669,7 +32747,7 @@ } }, { - "id": 768, + "id": 789, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -31696,7 +32774,7 @@ { "title": "Properties", "kind": 1024, - "children": [770, 769, 767, 768] + "children": [791, 790, 788, 789] } ], "sources": [ @@ -31714,7 +32792,7 @@ { "title": "Properties", "kind": 1024, - "children": [764, 765] + "children": [785, 786] } ], "sources": [ @@ -31729,14 +32807,14 @@ { "type": "reflection", "declaration": { - "id": 771, + "id": 792, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 773, + "id": 794, "name": "options", "kind": 1024, "kindString": "Property", @@ -31753,14 +32831,14 @@ "type": { "type": "reflection", "declaration": { - "id": 774, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 777, + "id": 798, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -31783,7 +32861,7 @@ } }, { - "id": 778, + "id": 799, "name": "channel", "kind": 1024, "kindString": "Property", @@ -31815,7 +32893,7 @@ } }, { - "id": 776, + "id": 797, "name": "data", "kind": 1024, "kindString": "Property", @@ -31839,7 +32917,7 @@ } }, { - "id": 775, + "id": 796, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -31866,7 +32944,7 @@ { "title": "Properties", "kind": 1024, - "children": [777, 778, 776, 775] + "children": [798, 799, 797, 796] } ], "sources": [ @@ -31880,7 +32958,7 @@ } }, { - "id": 772, + "id": 793, "name": "phone", "kind": 1024, "kindString": "Property", @@ -31905,7 +32983,7 @@ { "title": "Properties", "kind": 1024, - "children": [773, 772] + "children": [794, 793] } ], "sources": [ @@ -31921,7 +32999,7 @@ } }, { - "id": 838, + "id": 859, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -31939,14 +33017,14 @@ { "type": "reflection", "declaration": { - "id": 839, + "id": 860, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 862, "name": "options", "kind": 1024, "kindString": "Property", @@ -31963,14 +33041,14 @@ "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -31993,7 +33071,7 @@ } }, { - "id": 843, + "id": 864, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -32020,7 +33098,7 @@ { "title": "Properties", "kind": 1024, - "children": [844, 843] + "children": [865, 864] } ], "sources": [ @@ -32034,7 +33112,7 @@ } }, { - "id": 840, + "id": 861, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -32059,7 +33137,7 @@ { "title": "Properties", "kind": 1024, - "children": [841, 840] + "children": [862, 861] } ], "sources": [ @@ -32074,14 +33152,14 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 866, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 867, "name": "domain", "kind": 1024, "kindString": "Property", @@ -32102,7 +33180,7 @@ } }, { - "id": 847, + "id": 868, "name": "options", "kind": 1024, "kindString": "Property", @@ -32119,14 +33197,14 @@ "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 869, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 850, + "id": 871, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -32149,7 +33227,7 @@ } }, { - "id": 849, + "id": 870, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -32176,7 +33254,7 @@ { "title": "Properties", "kind": 1024, - "children": [850, 849] + "children": [871, 870] } ], "sources": [ @@ -32194,7 +33272,7 @@ { "title": "Properties", "kind": 1024, - "children": [846, 847] + "children": [867, 868] } ], "sources": [ @@ -32210,7 +33288,7 @@ } }, { - "id": 1052, + "id": 1073, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -32225,14 +33303,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1053, + "id": 1074, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1054, + "id": 1075, "name": "scope", "kind": 1024, "kindString": "Property", @@ -32272,7 +33350,7 @@ { "title": "Properties", "kind": 1024, - "children": [1054] + "children": [1075] } ], "sources": [ @@ -32286,7 +33364,7 @@ } }, { - "id": 732, + "id": 753, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -32304,14 +33382,14 @@ { "type": "reflection", "declaration": { - "id": 733, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 734, + "id": 755, "name": "email", "kind": 1024, "kindString": "Property", @@ -32332,7 +33410,7 @@ } }, { - "id": 736, + "id": 757, "name": "options", "kind": 1024, "kindString": "Property", @@ -32349,14 +33427,14 @@ "type": { "type": "reflection", "declaration": { - "id": 737, + "id": 758, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 740, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -32379,7 +33457,7 @@ } }, { - "id": 739, + "id": 760, "name": "data", "kind": 1024, "kindString": "Property", @@ -32403,7 +33481,7 @@ } }, { - "id": 738, + "id": 759, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -32430,7 +33508,7 @@ { "title": "Properties", "kind": 1024, - "children": [740, 739, 738] + "children": [761, 760, 759] } ], "sources": [ @@ -32444,7 +33522,7 @@ } }, { - "id": 735, + "id": 756, "name": "password", "kind": 1024, "kindString": "Property", @@ -32469,7 +33547,7 @@ { "title": "Properties", "kind": 1024, - "children": [734, 736, 735] + "children": [755, 757, 756] } ], "sources": [ @@ -32484,14 +33562,14 @@ { "type": "reflection", "declaration": { - "id": 741, + "id": 762, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -32508,14 +33586,14 @@ "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 747, + "id": 768, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -32538,7 +33616,7 @@ } }, { - "id": 748, + "id": 769, "name": "channel", "kind": 1024, "kindString": "Property", @@ -32570,7 +33648,7 @@ } }, { - "id": 746, + "id": 767, "name": "data", "kind": 1024, "kindString": "Property", @@ -32598,7 +33676,7 @@ { "title": "Properties", "kind": 1024, - "children": [747, 748, 746] + "children": [768, 769, 767] } ], "sources": [ @@ -32612,7 +33690,7 @@ } }, { - "id": 743, + "id": 764, "name": "password", "kind": 1024, "kindString": "Property", @@ -32633,7 +33711,7 @@ } }, { - "id": 742, + "id": 763, "name": "phone", "kind": 1024, "kindString": "Property", @@ -32658,7 +33736,7 @@ { "title": "Properties", "kind": 1024, - "children": [744, 743, 742] + "children": [765, 764, 763] } ], "sources": [ @@ -32674,7 +33752,7 @@ } }, { - "id": 1028, + "id": 1049, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -32729,14 +33807,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1050, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1030, + "id": 1051, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -32763,7 +33841,7 @@ { "title": "Properties", "kind": 1024, - "children": [1030] + "children": [1051] } ], "sources": [ @@ -32779,7 +33857,7 @@ } }, { - "id": 624, + "id": 645, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -32797,14 +33875,14 @@ { "type": "reflection", "declaration": { - "id": 625, + "id": 646, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 647, "name": "data", "kind": 1024, "kindString": "Property", @@ -32819,14 +33897,14 @@ "type": { "type": "reflection", "declaration": { - "id": 627, + "id": 648, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 628, + "id": 649, "name": "user", "kind": 1024, "kindString": "Property", @@ -32840,7 +33918,7 @@ ], "type": { "type": "reference", - "id": 675, + "id": 696, "name": "User" } } @@ -32849,7 +33927,7 @@ { "title": "Properties", "kind": 1024, - "children": [628] + "children": [649] } ], "sources": [ @@ -32863,7 +33941,7 @@ } }, { - "id": 629, + "id": 650, "name": "error", "kind": 1024, "kindString": "Property", @@ -32885,7 +33963,7 @@ { "title": "Properties", "kind": 1024, - "children": [626, 629] + "children": [647, 650] } ], "sources": [ @@ -32900,14 +33978,14 @@ { "type": "reflection", "declaration": { - "id": 630, + "id": 651, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 631, + "id": 652, "name": "data", "kind": 1024, "kindString": "Property", @@ -32922,14 +34000,14 @@ "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 653, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 633, + "id": 654, "name": "user", "kind": 1024, "kindString": "Property", @@ -32951,7 +34029,7 @@ { "title": "Properties", "kind": 1024, - "children": [633] + "children": [654] } ], "sources": [ @@ -32965,7 +34043,7 @@ } }, { - "id": 634, + "id": 655, "name": "error", "kind": 1024, "kindString": "Property", @@ -32979,7 +34057,7 @@ ], "type": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -32988,7 +34066,7 @@ { "title": "Properties", "kind": 1024, - "children": [631, 634] + "children": [652, 655] } ], "sources": [ @@ -33004,7 +34082,7 @@ } }, { - "id": 802, + "id": 823, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -33020,14 +34098,14 @@ "type": "union", "types": [ { - "id": 803, + "id": 824, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -33044,14 +34122,14 @@ "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -33080,7 +34158,7 @@ } }, { - "id": 809, + "id": 830, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -33107,14 +34185,14 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ] } } }, { - "id": 804, + "id": 825, "name": "phone", "kind": 1024, "kindString": "Property", @@ -33135,7 +34213,7 @@ } }, { - "id": 805, + "id": 826, "name": "token", "kind": 1024, "kindString": "Property", @@ -33156,7 +34234,7 @@ } }, { - "id": 806, + "id": 827, "name": "type", "kind": 1024, "kindString": "Property", @@ -33173,10 +34251,10 @@ ], "type": { "type": "reference", - "id": 822, + "id": 843, "name": "MobileOtpType", "dereferenced": { - "id": 822, + "id": 843, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -33209,7 +34287,7 @@ { "title": "Properties", "kind": 1024, - "children": [807, 804, 805, 806] + "children": [828, 825, 826, 827] } ], "sources": [ @@ -33221,14 +34299,14 @@ ] }, { - "id": 811, + "id": 832, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 812, + "id": 833, "name": "email", "kind": 1024, "kindString": "Property", @@ -33249,7 +34327,7 @@ } }, { - "id": 815, + "id": 836, "name": "options", "kind": 1024, "kindString": "Property", @@ -33266,14 +34344,14 @@ "type": { "type": "reflection", "declaration": { - "id": 816, + "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 818, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -33302,7 +34380,7 @@ } }, { - "id": 817, + "id": 838, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -33329,14 +34407,14 @@ { "title": "Properties", "kind": 1024, - "children": [818, 817] + "children": [839, 838] } ] } } }, { - "id": 813, + "id": 834, "name": "token", "kind": 1024, "kindString": "Property", @@ -33357,7 +34435,7 @@ } }, { - "id": 814, + "id": 835, "name": "type", "kind": 1024, "kindString": "Property", @@ -33374,10 +34452,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -33426,7 +34504,7 @@ { "title": "Properties", "kind": 1024, - "children": [812, 815, 813, 814] + "children": [833, 836, 834, 835] } ], "sources": [ @@ -33438,14 +34516,14 @@ ] }, { - "id": 819, + "id": 840, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -33466,7 +34544,7 @@ } }, { - "id": 821, + "id": 842, "name": "type", "kind": 1024, "kindString": "Property", @@ -33483,10 +34561,10 @@ ], "type": { "type": "reference", - "id": 823, + "id": 844, "name": "EmailOtpType", "dereferenced": { - "id": 823, + "id": 844, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -33535,7 +34613,7 @@ { "title": "Properties", "kind": 1024, - "children": [820, 821] + "children": [841, 842] } ], "sources": [ @@ -33550,7 +34628,7 @@ } }, { - "id": 528, + "id": 549, "name": "WeakPassword", "kind": 4194304, "kindString": "Type alias", @@ -33565,14 +34643,14 @@ "type": { "type": "reflection", "declaration": { - "id": 529, + "id": 550, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 552, "name": "message", "kind": 1024, "kindString": "Property", @@ -33590,7 +34668,7 @@ } }, { - "id": 530, + "id": 551, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -33606,7 +34684,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 526, + "id": 547, "name": "WeakPasswordReasons" } } @@ -33616,7 +34694,7 @@ { "title": "Properties", "kind": 1024, - "children": [531, 530] + "children": [552, 551] } ], "sources": [ @@ -33630,7 +34708,7 @@ } }, { - "id": 526, + "id": 547, "name": "WeakPasswordReasons", "kind": 4194304, "kindString": "Type alias", @@ -33667,7 +34745,7 @@ { "type": "reflection", "declaration": { - "id": 527, + "id": 548, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33687,7 +34765,7 @@ } }, { - "id": 475, + "id": 496, "name": "AuthAdminApi", "kind": 32, "kindString": "Variable", @@ -33712,7 +34790,7 @@ "defaultValue": "GoTrueAdminApi" }, { - "id": 476, + "id": 497, "name": "AuthClient", "kind": 32, "kindString": "Variable", @@ -33737,7 +34815,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 490, + "id": 511, "name": "lockInternals", "kind": 32, "kindString": "Variable", @@ -33762,14 +34840,14 @@ "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 512, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 492, + "id": 513, "name": "debug", "kind": 1024, "kindString": "Property", @@ -33800,7 +34878,7 @@ { "title": "Properties", "kind": 1024, - "children": [492] + "children": [513] } ] } @@ -33808,7 +34886,7 @@ "defaultValue": "..." }, { - "id": 1096, + "id": 1143, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -33822,14 +34900,14 @@ ], "signatures": [ { - "id": 1097, + "id": 1144, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1098, + "id": 1145, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -33846,7 +34924,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1121, + "id": 1168, "name": "AuthApiError" } } @@ -33854,7 +34932,7 @@ ] }, { - "id": 1093, + "id": 1140, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -33868,14 +34946,14 @@ ], "signatures": [ { - "id": 1094, + "id": 1141, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1095, + "id": 1142, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -33892,7 +34970,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1111, + "id": 1158, "name": "AuthError" } } @@ -33900,7 +34978,7 @@ ] }, { - "id": 1102, + "id": 1149, "name": "isAuthImplicitGrantRedirectError", "kind": 64, "kindString": "Function", @@ -33914,14 +34992,14 @@ ], "signatures": [ { - "id": 1103, + "id": 1150, "name": "isAuthImplicitGrantRedirectError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1104, + "id": 1151, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -33938,7 +35016,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1178, + "id": 1225, "name": "AuthImplicitGrantRedirectError" } } @@ -33946,7 +35024,7 @@ ] }, { - "id": 1105, + "id": 1152, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -33960,14 +35038,14 @@ ], "signatures": [ { - "id": 1106, + "id": 1153, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1107, + "id": 1154, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -33984,7 +35062,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1232, + "id": 1279, "name": "AuthRetryableFetchError" } } @@ -33992,7 +35070,7 @@ ] }, { - "id": 1099, + "id": 1146, "name": "isAuthSessionMissingError", "kind": 64, "kindString": "Function", @@ -34006,14 +35084,14 @@ ], "signatures": [ { - "id": 1100, + "id": 1147, "name": "isAuthSessionMissingError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1101, + "id": 1148, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -34030,7 +35108,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1153, + "id": 1200, "name": "AuthSessionMissingError" } } @@ -34038,7 +35116,7 @@ ] }, { - "id": 1108, + "id": 1155, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -34052,14 +35130,14 @@ ], "signatures": [ { - "id": 1109, + "id": 1156, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1157, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -34076,7 +35154,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1242, + "id": 1289, "name": "AuthWeakPasswordError" } } @@ -34084,7 +35162,7 @@ ] }, { - "id": 477, + "id": 498, "name": "navigatorLock", "kind": 64, "kindString": "Function", @@ -34098,7 +35176,7 @@ ], "signatures": [ { - "id": 478, + "id": 499, "name": "navigatorLock", "kind": 4096, "kindString": "Call signature", @@ -34109,7 +35187,7 @@ }, "typeParameter": [ { - "id": 479, + "id": 500, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -34118,7 +35196,7 @@ ], "parameters": [ { - "id": 480, + "id": 501, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -34132,7 +35210,7 @@ } }, { - "id": 481, + "id": 502, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -34146,7 +35224,7 @@ } }, { - "id": 482, + "id": 503, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -34157,14 +35235,14 @@ "type": { "type": "reflection", "declaration": { - "id": 483, + "id": 504, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 484, + "id": 505, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -34174,7 +35252,7 @@ "typeArguments": [ { "type": "reference", - "id": 479, + "id": 500, "name": "R" } ], @@ -34193,7 +35271,7 @@ "typeArguments": [ { "type": "reference", - "id": 479, + "id": 500, "name": "R" } ], @@ -34209,32 +35287,36 @@ { "title": "Classes", "kind": 128, - "children": [1121, 1111, 1178, 1169, 1161, 1205, 1232, 1153, 1131, 1242, 1141, 1, 78, 485] + "children": [ + 1168, 1158, 1225, 1216, 1301, 1208, 1252, 1279, 1200, 1178, 1289, 1188, 1, 78, 506 + ] }, { "title": "Interfaces", "kind": 256, - "children": [644, 705, 660, 873, 1021, 972, 635, 718, 675, 668, 699, 648, 672, 811, 803, 819] + "children": [ + 665, 726, 681, 894, 1042, 993, 1133, 656, 739, 696, 689, 720, 669, 693, 832, 824, 840 + ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 495, 494, 779, 1005, 996, 1018, 1009, 938, 1081, 928, 1065, 961, 949, 929, 915, 559, 532, - 545, 574, 587, 960, 1034, 823, 867, 857, 876, 890, 877, 897, 862, 851, 505, 1031, 496, 911, - 907, 898, 1060, 1055, 899, 902, 822, 602, 1048, 1041, 493, 824, 615, 726, 792, 780, 749, - 762, 838, 1052, 732, 1028, 624, 802, 528, 526 + 516, 515, 800, 1026, 1017, 1039, 1030, 959, 1102, 949, 1086, 982, 970, 950, 936, 580, 553, + 566, 595, 608, 981, 1055, 844, 888, 878, 897, 911, 898, 918, 883, 872, 526, 1052, 1114, + 1129, 517, 932, 928, 919, 1081, 1076, 920, 923, 843, 623, 1069, 1062, 514, 1119, 845, 636, + 747, 813, 801, 770, 783, 859, 1073, 753, 1049, 645, 823, 549, 547 ] }, { "title": "Variables", "kind": 32, - "children": [475, 476, 490] + "children": [496, 497, 511] }, { "title": "Functions", "kind": 64, - "children": [1096, 1093, 1102, 1105, 1099, 1108, 477] + "children": [1143, 1140, 1149, 1152, 1146, 1155, 498] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json index 1a2840cc303..ccad9fc904f 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 616, + "id": 632, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -24,27 +24,27 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 23, + "line": 31, "character": 2 } ], "signatures": [ { - "id": 617, + "id": 633, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 618, + "id": 634, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 619, + "id": 635, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -61,18 +61,18 @@ ], "parameters": [ { - "id": 620, + "id": 636, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -86,16 +86,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -105,7 +105,7 @@ ] }, { - "id": 625, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -116,7 +116,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -126,7 +126,7 @@ } }, { - "id": 628, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -136,28 +136,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 630, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 631, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -181,7 +181,7 @@ } }, { - "id": 632, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -216,7 +216,7 @@ } }, { - "id": 623, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -226,7 +226,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -248,7 +248,7 @@ } }, { - "id": 633, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -258,7 +258,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -268,7 +268,7 @@ } }, { - "id": 621, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -278,7 +278,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -309,7 +309,7 @@ } }, { - "id": 624, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -320,7 +320,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -330,7 +330,7 @@ } }, { - "id": 626, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -340,7 +340,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -351,7 +351,7 @@ "defaultValue": "false" }, { - "id": 627, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -362,7 +362,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -374,7 +374,7 @@ } }, { - "id": 622, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -384,7 +384,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -396,7 +396,346 @@ } }, { - "id": 636, + "id": 671, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 672, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 673, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 678, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 674, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 675, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [675] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 676, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 677, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [677] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 668, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 669, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with" + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 670, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -404,13 +743,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 637, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -420,7 +759,7 @@ }, "parameters": [ { - "id": 638, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -431,7 +770,7 @@ } }, { - "id": 639, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -444,16 +783,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -463,7 +802,7 @@ ] }, { - "id": 640, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -471,20 +810,20 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 641, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 642, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -493,7 +832,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -502,11 +841,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -514,11 +853,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -527,7 +866,7 @@ } }, { - "id": 643, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -540,7 +879,7 @@ ], "parameters": [ { - "id": 644, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -557,21 +896,21 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 646, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 647, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -580,7 +919,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -589,11 +928,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -601,11 +940,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -645,7 +984,7 @@ } }, { - "id": 648, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -662,21 +1001,21 @@ { "type": "reflection", "declaration": { - "id": 649, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 650, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -753,7 +1092,7 @@ } }, { - "id": 634, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -761,13 +1100,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 635, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -781,16 +1120,16 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -798,11 +1137,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -822,36 +1161,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -869,7 +1208,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -881,7 +1220,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -890,11 +1229,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -902,11 +1241,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -2292,7 +2631,7 @@ ] }, { - "id": 654, + "id": 681, "name": "PostgrestError", "kind": 128, "kindString": "Class", @@ -2303,7 +2642,7 @@ }, "children": [ { - "id": 655, + "id": 682, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2317,14 +2656,14 @@ ], "signatures": [ { - "id": 656, + "id": 683, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 657, + "id": 684, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -2332,14 +2671,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 662, + "id": 689, "name": "code", "kind": 1024, "kindString": "Property", @@ -2357,7 +2696,7 @@ } }, { - "id": 660, + "id": 687, "name": "details", "kind": 1024, "kindString": "Property", @@ -2375,7 +2714,7 @@ } }, { - "id": 661, + "id": 688, "name": "hint", "kind": 1024, "kindString": "Property", @@ -2393,7 +2732,7 @@ } }, { - "id": 659, + "id": 686, "name": "message", "kind": 1024, "kindString": "Property", @@ -2415,7 +2754,7 @@ { "title": "Properties", "kind": 1024, - "children": [662, 660, 661, 659] + "children": [689, 687, 688, 686] } ] } @@ -2424,7 +2763,7 @@ ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" }, "overwrites": { @@ -2439,7 +2778,7 @@ } }, { - "id": 665, + "id": 692, "name": "code", "kind": 1024, "kindString": "Property", @@ -2457,7 +2796,7 @@ } }, { - "id": 663, + "id": 690, "name": "details", "kind": 1024, "kindString": "Property", @@ -2475,7 +2814,7 @@ } }, { - "id": 664, + "id": 691, "name": "hint", "kind": 1024, "kindString": "Property", @@ -2497,12 +2836,12 @@ { "title": "Constructors", "kind": 512, - "children": [655] + "children": [682] }, { "title": "Properties", "kind": 1024, - "children": [665, 663, 664] + "children": [692, 690, 691] } ], "sources": [ @@ -2615,7 +2954,7 @@ "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -2665,14 +3004,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 493, + "id": 501, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 492, + "id": 500, "name": "default.constructor" } }, @@ -2688,7 +3027,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -2698,7 +3037,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 583, + "id": 591, "name": "default.body" } }, @@ -2713,7 +3052,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], @@ -2793,7 +3132,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 586, + "id": 594, "name": "default.fetch" } }, @@ -2808,7 +3147,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -2830,7 +3169,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 589, "name": "default.headers" } }, @@ -2845,7 +3184,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -2855,7 +3194,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 591, + "id": 599, "name": "default.isMaybeSingle" } }, @@ -2870,7 +3209,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -2901,7 +3240,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 587, "name": "default.method" } }, @@ -2917,7 +3256,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -2927,7 +3266,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 582, + "id": 590, "name": "default.schema" } }, @@ -2942,7 +3281,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -2953,7 +3292,7 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 584, + "id": 592, "name": "default.shouldThrowOnError" } }, @@ -2969,7 +3308,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -2981,7 +3320,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 585, + "id": 593, "name": "default.signal" } }, @@ -2996,7 +3335,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -3008,7 +3347,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 588, "name": "default.url" } }, @@ -3087,14 +3426,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 552, + "id": 560, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 551, + "id": 559, "name": "default.abortSignal" } }, @@ -3617,7 +3956,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -3632,14 +3971,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 561, + "id": 569, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 560, + "id": 568, "name": "default.csv" } }, @@ -4027,7 +4366,7 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -4042,7 +4381,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "array", @@ -4074,14 +4413,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 565, + "id": 573, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 564, + "id": 572, "name": "default.explain" } }, @@ -4407,7 +4746,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -4434,14 +4773,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 563, + "id": 571, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 562, + "id": 570, "name": "default.geojson" } }, @@ -6486,14 +6825,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 537, + "id": 545, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 536, + "id": 544, "name": "default.limit" } }, @@ -7100,7 +7439,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "union", @@ -7125,14 +7464,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 558, + "id": 566, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 557, + "id": 565, "name": "default.maybeSingle" } }, @@ -7855,7 +8194,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 506, + "id": 514, "name": "default.order" } }, @@ -8019,7 +8358,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 514, + "id": 522, "name": "default.order" } }, @@ -8194,7 +8533,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 521, + "id": 529, "name": "default.order" } }, @@ -8355,14 +8694,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 529, + "id": 537, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 505, + "id": 513, "name": "default.order" } }, @@ -8581,6 +8920,282 @@ } ] }, + { + "id": 486, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 487, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 488, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 493, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 489, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 490, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [490] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 491, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 492, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [492] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 619, + "name": "default.overrideTypes" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 618, + "name": "default.overrideTypes" + } + }, { "id": 419, "name": "range", @@ -8745,14 +9360,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 544, + "id": 552, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 543, + "id": 551, "name": "default.range" } }, @@ -9635,7 +10250,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 311, + "line": 312, "character": 2 } ], @@ -9647,7 +10262,13 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`." + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] }, "typeParameter": [ { @@ -9657,13 +10278,13 @@ "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with\n" + "shortText": "The new result type to override with" } } ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -9677,8 +10298,19 @@ }, { "type": "reference", - "id": 454, - "name": "NewResult" + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 454, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" }, { "type": "reference", @@ -9695,14 +10327,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 585, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 576, + "id": 584, "name": "default.returns" } }, @@ -9764,14 +10396,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 575, + "id": 583, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 574, + "id": 582, "name": "default.rollback" } }, @@ -9823,7 +10455,7 @@ "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", @@ -9876,7 +10508,7 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -9911,14 +10543,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 501, + "id": 509, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 500, + "id": 508, "name": "default.select" } }, @@ -9931,7 +10563,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], @@ -10003,14 +10635,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 595, + "id": 603, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 594, + "id": 602, "name": "default.setHeader" } }, @@ -10072,7 +10704,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -10088,14 +10720,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 555, + "id": 563, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 554, + "id": 562, "name": "default.single" } }, @@ -10462,7 +11094,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], @@ -10482,7 +11114,7 @@ "flags": {}, "default": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", @@ -10545,7 +11177,7 @@ "flags": {}, "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", @@ -10686,14 +11318,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 599, + "id": 607, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 598, + "id": 606, "name": "default.then" } }, @@ -10706,7 +11338,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], @@ -10758,7 +11390,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -10776,14 +11408,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 593, + "id": 601, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 592, + "id": 600, "name": "default.throwOnError" } } @@ -10804,8 +11436,8 @@ "kind": 2048, "children": [ 427, 271, 263, 436, 160, 440, 366, 438, 170, 178, 226, 234, 242, 258, 250, 202, 210, - 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 419, 311, 279, 287, 295, 303, - 452, 450, 376, 470, 430, 327, 474, 468 + 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 486, 419, 311, 279, 287, 295, + 303, 452, 450, 376, 470, 430, 327, 474, 468 ] } ], @@ -10818,7 +11450,7 @@ ], "typeParameter": [ { - "id": 486, + "id": 494, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -10829,7 +11461,7 @@ } }, { - "id": 487, + "id": 495, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -10852,14 +11484,14 @@ } }, { - "id": 488, + "id": 496, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 489, + "id": 497, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -10870,7 +11502,7 @@ } }, { - "id": 490, + "id": 498, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -10884,7 +11516,7 @@ "extendedTypes": [ { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -11981,7 +12613,7 @@ "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", @@ -12936,28 +13568,28 @@ ] }, { - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 492, + "id": 500, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 493, + "id": 501, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 494, + "id": 502, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -12968,7 +13600,7 @@ } }, { - "id": 495, + "id": 503, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -12991,14 +13623,14 @@ } }, { - "id": 496, + "id": 504, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 497, + "id": 505, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -13009,7 +13641,7 @@ } }, { - "id": 498, + "id": 506, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -13022,18 +13654,18 @@ ], "parameters": [ { - "id": 499, + "id": 507, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { @@ -13047,31 +13679,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -13079,19 +13711,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 617, + "id": 633, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 616, + "id": 632, "name": "default.constructor" } }, { - "id": 583, + "id": 591, "name": "body", "kind": 1024, "kindString": "Property", @@ -13102,7 +13734,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -13112,12 +13744,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 625, + "id": 641, "name": "default.body" } }, { - "id": 586, + "id": 594, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -13127,28 +13759,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 587, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 588, + "id": 596, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 589, + "id": 597, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -13172,7 +13804,7 @@ } }, { - "id": 590, + "id": 598, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -13207,12 +13839,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 628, + "id": 644, "name": "default.fetch" } }, { - "id": 581, + "id": 589, "name": "headers", "kind": 1024, "kindString": "Property", @@ -13222,7 +13854,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -13244,12 +13876,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 623, + "id": 639, "name": "default.headers" } }, { - "id": 591, + "id": 599, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -13259,7 +13891,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -13269,12 +13901,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 633, + "id": 649, "name": "default.isMaybeSingle" } }, { - "id": 579, + "id": 587, "name": "method", "kind": 1024, "kindString": "Property", @@ -13284,7 +13916,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -13315,12 +13947,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 621, + "id": 637, "name": "default.method" } }, { - "id": 582, + "id": 590, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13331,7 +13963,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -13341,12 +13973,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 624, + "id": 640, "name": "default.schema" } }, { - "id": 584, + "id": 592, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -13356,7 +13988,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -13367,12 +13999,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 626, + "id": 642, "name": "default.shouldThrowOnError" } }, { - "id": 585, + "id": 593, "name": "signal", "kind": 1024, "kindString": "Property", @@ -13383,7 +14015,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -13395,12 +14027,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 627, + "id": 643, "name": "default.signal" } }, { - "id": 580, + "id": 588, "name": "url", "kind": 1024, "kindString": "Property", @@ -13410,7 +14042,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -13422,12 +14054,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 622, + "id": 638, "name": "default.url" } }, { - "id": 551, + "id": 559, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -13441,7 +14073,7 @@ ], "signatures": [ { - "id": 552, + "id": 560, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -13451,7 +14083,7 @@ }, "parameters": [ { - "id": 553, + "id": 561, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -13469,31 +14101,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -13503,7 +14135,7 @@ ] }, { - "id": 560, + "id": 568, "name": "csv", "kind": 2048, "kindString": "Method", @@ -13517,7 +14149,7 @@ ], "signatures": [ { - "id": 561, + "id": 569, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -13527,7 +14159,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -13544,7 +14176,7 @@ ] }, { - "id": 564, + "id": 572, "name": "explain", "kind": 2048, "kindString": "Method", @@ -13558,7 +14190,7 @@ ], "signatures": [ { - "id": 565, + "id": 573, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -13569,7 +14201,7 @@ }, "parameters": [ { - "id": 566, + "id": 574, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -13581,14 +14213,14 @@ "type": { "type": "reflection", "declaration": { - "id": 567, + "id": 575, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 576, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -13611,7 +14243,7 @@ } }, { - "id": 571, + "id": 579, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -13634,7 +14266,7 @@ } }, { - "id": 573, + "id": 581, "name": "format", "kind": 1024, "kindString": "Property", @@ -13666,7 +14298,7 @@ } }, { - "id": 570, + "id": 578, "name": "settings", "kind": 1024, "kindString": "Property", @@ -13689,7 +14321,7 @@ } }, { - "id": 569, + "id": 577, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -13712,7 +14344,7 @@ } }, { - "id": 572, + "id": 580, "name": "wal", "kind": 1024, "kindString": "Property", @@ -13739,7 +14371,7 @@ { "title": "Properties", "kind": 1024, - "children": [568, 571, 573, 570, 569, 572] + "children": [576, 579, 581, 578, 577, 580] } ] } @@ -13752,7 +14384,7 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -13767,7 +14399,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "array", @@ -13801,7 +14433,7 @@ ] }, { - "id": 562, + "id": 570, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -13815,7 +14447,7 @@ ], "signatures": [ { - "id": 563, + "id": 571, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -13825,7 +14457,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -13854,7 +14486,7 @@ ] }, { - "id": 536, + "id": 544, "name": "limit", "kind": 2048, "kindString": "Method", @@ -13868,7 +14500,7 @@ ], "signatures": [ { - "id": 537, + "id": 545, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -13878,7 +14510,7 @@ }, "parameters": [ { - "id": 538, + "id": 546, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -13891,929 +14523,6 @@ "name": "number" } }, - { - "id": 539, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 9 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 32 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [541, 542] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 557, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 2 - } - ], - "signatures": [ - { - "id": 558, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "typeParameter": [ - { - "id": 559, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 496, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "id": 615, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 435, - "name": "ResultOne" - } - ] - }, - { - "type": "literal", - "value": false - } - ], - "name": "default" - } - } - ] - }, - { - "id": 505, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 506, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" - }, - "typeParameter": [ - { - "id": 507, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 508, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 383, - "name": "ColumnName" - } - }, - { - "id": 509, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 511, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 512, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 513, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a referenced table by\nits columns" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [511, 512, 513] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 514, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" - }, - "parameters": [ - { - "id": 515, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 516, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 517, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 518, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 519, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 520, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a referenced table by\nits columns" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [518, 519, 520] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 521, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" - } - ] - }, - "typeParameter": [ - { - "id": 522, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 523, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 398, - "name": "ColumnName" - } - }, - { - "id": 524, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 528, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 527, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [526, 528, 527] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 529, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" - } - ] - }, - "parameters": [ - { - "id": 530, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 531, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 533, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 535, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [533, 535, 534] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 543, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 158, - "character": 2 - } - ], - "signatures": [ - { - "id": 544, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." - }, - "parameters": [ - { - "id": 545, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 546, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, { "id": 547, "name": "options", @@ -14847,7 +14556,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 164, + "line": 136, "character": 9 } ], @@ -14867,6 +14576,1205 @@ "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 136, + "character": 32 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [549, 550] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 565, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 204, + "character": 2 + } + ], + "signatures": [ + { + "id": 566, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + }, + "typeParameter": [ + { + "id": 567, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 504, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 435, + "name": "ResultOne" + } + ] + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + } + } + ] + }, + { + "id": 513, + "name": "order", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 514, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + }, + "typeParameter": [ + { + "id": 515, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 516, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName" + } + }, + { + "id": 517, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 518, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 519, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 520, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 521, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a referenced table by\nits columns" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [519, 520, 521] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 522, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + }, + "parameters": [ + { + "id": 523, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 524, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 525, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 526, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 527, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 528, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a referenced table by\nits columns" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [526, 527, 528] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 529, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", + "tags": [ + { + "tag": "deprecated", + "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + } + ] + }, + "typeParameter": [ + { + "id": 530, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 531, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 398, + "name": "ColumnName" + } + }, + { + "id": 532, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 533, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 534, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 536, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + }, + { + "id": 535, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [534, 536, 535] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 537, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", + "tags": [ + { + "tag": "deprecated", + "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + } + ] + }, + "parameters": [ + { + "id": 538, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 539, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 540, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 541, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 543, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 542, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [541, 543, 542] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 618, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 619, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 620, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 625, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 621, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 622, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [622] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 623, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 624, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [624] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 672, + "name": "default.overrideTypes" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 671, + "name": "default.overrideTypes" + } + }, + { + "id": 551, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 158, + "character": 2 + } + ], + "signatures": [ + { + "id": 552, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + }, + "parameters": [ + { + "id": 553, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 554, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 555, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 556, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 557, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 164, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 558, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", @@ -14884,7 +15792,7 @@ { "title": "Properties", "kind": 1024, - "children": [549, 550] + "children": [557, 558] } ] } @@ -14894,31 +15802,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -14928,7 +15836,7 @@ ] }, { - "id": 576, + "id": 584, "name": "returns", "kind": 2048, "kindString": "Method", @@ -14936,69 +15844,96 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 311, + "line": 312, "character": 2 } ], "signatures": [ { - "id": 577, + "id": 585, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`." + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] }, "typeParameter": [ { - "id": 578, + "id": 586, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with\n" + "shortText": "The new result type to override with" } } ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 454, - "name": "NewResult" + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 454, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], "name": "default" + }, + "overwrites": { + "type": "reference", + "id": 669, + "name": "default.returns" } } - ] + ], + "overwrites": { + "type": "reference", + "id": 668, + "name": "default.returns" + } }, { - "id": 574, + "id": 582, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -15012,7 +15947,7 @@ ], "signatures": [ { - "id": 575, + "id": 583, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -15023,31 +15958,31 @@ }, "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -15057,7 +15992,7 @@ ] }, { - "id": 500, + "id": 508, "name": "select", "kind": 2048, "kindString": "Method", @@ -15071,7 +16006,7 @@ ], "signatures": [ { - "id": 501, + "id": 509, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -15082,7 +16017,7 @@ }, "typeParameter": [ { - "id": 502, + "id": 510, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -15097,33 +16032,33 @@ } }, { - "id": 503, + "id": 511, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" }, { @@ -15138,7 +16073,7 @@ ], "parameters": [ { - "id": 504, + "id": 512, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -15157,16 +16092,16 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { @@ -15179,12 +16114,12 @@ }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -15194,7 +16129,7 @@ ] }, { - "id": 594, + "id": 602, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -15202,13 +16137,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 595, + "id": 603, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -15218,7 +16153,7 @@ }, "parameters": [ { - "id": 596, + "id": 604, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -15229,7 +16164,7 @@ } }, { - "id": 597, + "id": 605, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -15242,31 +16177,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -15274,19 +16209,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 637, + "id": 653, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 636, + "id": 652, "name": "default.setHeader" } }, { - "id": 554, + "id": 562, "name": "single", "kind": 2048, "kindString": "Method", @@ -15300,7 +16235,7 @@ ], "signatures": [ { - "id": 555, + "id": 563, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -15311,7 +16246,7 @@ }, "typeParameter": [ { - "id": 556, + "id": 564, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -15320,7 +16255,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, "extendsType": { @@ -15343,7 +16278,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -15361,7 +16296,7 @@ ] }, { - "id": 598, + "id": 606, "name": "then", "kind": 2048, "kindString": "Method", @@ -15369,31 +16304,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 599, + "id": 607, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 600, + "id": 608, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -15401,7 +16336,7 @@ } }, { - "id": 601, + "id": 609, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -15414,7 +16349,7 @@ ], "parameters": [ { - "id": 602, + "id": 610, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -15431,32 +16366,32 @@ { "type": "reflection", "declaration": { - "id": 603, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 604, + "id": 612, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 605, + "id": 613, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -15495,7 +16430,7 @@ } }, { - "id": 606, + "id": 614, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -15512,21 +16447,21 @@ { "type": "reflection", "declaration": { - "id": 607, + "id": 615, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 608, + "id": 616, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 609, + "id": 617, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -15593,19 +16528,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 641, + "id": 657, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 640, + "id": 656, "name": "default.then" } }, { - "id": 592, + "id": 600, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -15613,13 +16548,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 593, + "id": 601, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -15633,31 +16568,31 @@ "types": [ { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -15665,11 +16600,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { @@ -15683,14 +16618,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 635, + "id": 651, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 634, + "id": 650, "name": "default.throwOnError" } } @@ -15699,17 +16634,19 @@ { "title": "Constructors", "kind": 512, - "children": [492] + "children": [500] }, { "title": "Properties", "kind": 1024, - "children": [583, 586, 581, 591, 579, 582, 584, 585, 580] + "children": [591, 594, 589, 599, 587, 590, 592, 593, 588] }, { "title": "Methods", "kind": 2048, - "children": [551, 560, 564, 562, 536, 557, 505, 543, 576, 574, 500, 594, 554, 598, 592] + "children": [ + 559, 568, 572, 570, 544, 565, 513, 618, 551, 584, 582, 508, 602, 562, 606, 600 + ] } ], "sources": [ @@ -15721,7 +16658,7 @@ ], "typeParameter": [ { - "id": 610, + "id": 626, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -15732,7 +16669,7 @@ } }, { - "id": 611, + "id": 627, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -15755,14 +16692,14 @@ } }, { - "id": 612, + "id": 628, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 613, + "id": 629, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -15773,7 +16710,7 @@ } }, { - "id": 614, + "id": 630, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -15787,11 +16724,11 @@ "extendedTypes": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -15807,18 +16744,54 @@ ] }, { - "id": 668, + "id": 695, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 671, + "id": 698, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 697, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 696, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -15826,50 +16799,14 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 669, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 20, - "character": 2 - } - ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" } }, { - "id": 672, + "id": 699, "name": "status", "kind": 1024, "kindString": "Property", @@ -15877,7 +16814,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -15891,7 +16828,7 @@ } }, { - "id": 673, + "id": 700, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -15899,7 +16836,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -15917,13 +16854,13 @@ { "title": "Properties", "kind": 1024, - "children": [671, 670, 669, 672, 673] + "children": [698, 697, 696, 699, 700] } ], "sources": [ { "fileName": "src/types.ts", - "line": 19, + "line": 21, "character": 17 } ], @@ -15935,14 +16872,14 @@ ] }, { - "id": 674, + "id": 701, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 677, + "id": 704, "name": "count", "kind": 1024, "kindString": "Property", @@ -15950,7 +16887,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 17, + "line": 19, "character": 2 } ], @@ -15969,7 +16906,7 @@ } }, { - "id": 676, + "id": 703, "name": "data", "kind": 1024, "kindString": "Property", @@ -15977,18 +16914,18 @@ "sources": [ { "fileName": "src/types.ts", - "line": 16, + "line": 18, "character": 2 } ], "type": { "type": "reference", - "id": 680, + "id": 707, "name": "T" } }, { - "id": 675, + "id": 702, "name": "error", "kind": 1024, "kindString": "Property", @@ -15996,7 +16933,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 15, + "line": 17, "character": 2 } ], @@ -16006,7 +16943,7 @@ } }, { - "id": 678, + "id": 705, "name": "status", "kind": 1024, "kindString": "Property", @@ -16014,7 +16951,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -16028,7 +16965,7 @@ } }, { - "id": 679, + "id": 706, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -16036,7 +16973,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -16054,19 +16991,19 @@ { "title": "Properties", "kind": 1024, - "children": [677, 676, 675, 678, 679] + "children": [704, 703, 702, 705, 706] } ], "sources": [ { "fileName": "src/types.ts", - "line": 14, + "line": 16, "character": 17 } ], "typeParameter": [ { - "id": 680, + "id": 707, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -16081,7 +17018,7 @@ ] }, { - "id": 683, + "id": 710, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -16089,13 +17026,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 31, "character": 12 } ], "typeParameter": [ { - "id": 684, + "id": 711, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -16104,14 +17041,14 @@ ], "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 684, + "id": 711, "name": "T" }, { @@ -16125,11 +17062,49 @@ } }, { - "id": 666, + "id": 693, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 32, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 694, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 708, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "id": 694, + "name": "T" + } + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 708, + "name": "PostgrestSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -16139,45 +17114,7 @@ ], "typeParameter": [ { - "id": 667, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reference", - "id": 681, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 667, - "name": "T" - } - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 681, - "name": "PostgrestSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 28, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 682, + "id": 709, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -16189,11 +17126,11 @@ "types": [ { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 682, + "id": 709, "name": "T" } ], @@ -16201,14 +17138,14 @@ }, { "type": "reference", - "id": 668, + "id": 695, "name": "PostgrestResponseFailure" } ] } }, { - "id": 685, + "id": 712, "name": "UnstableGetResult", "kind": 4194304, "kindString": "Type alias", @@ -16225,7 +17162,7 @@ ], "typeParameter": [ { - "id": 686, + "id": 713, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -16239,7 +17176,7 @@ } }, { - "id": 687, + "id": 714, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -16265,7 +17202,7 @@ } }, { - "id": 688, + "id": 715, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -16275,7 +17212,7 @@ } }, { - "id": 689, + "id": 716, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -16285,7 +17222,7 @@ } }, { - "id": 690, + "id": 717, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -16306,7 +17243,7 @@ "typeArguments": [ { "type": "reference", - "id": 686, + "id": 713, "name": "Schema" } ], @@ -16323,7 +17260,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -16350,7 +17287,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -16386,7 +17323,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, "extendsType": { @@ -16400,7 +17337,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -16434,7 +17371,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -16443,7 +17380,7 @@ }, "trueType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "falseType": { @@ -16453,7 +17390,7 @@ }, { "type": "reference", - "id": 687, + "id": 714, "name": "Row" } ], @@ -16466,7 +17403,7 @@ }, "falseType": { "type": "reference", - "id": 687, + "id": 714, "name": "Row" } }, @@ -16477,7 +17414,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -16504,7 +17441,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -16515,7 +17452,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, "extendsType": { @@ -16530,22 +17467,22 @@ "typeArguments": [ { "type": "reference", - "id": 686, + "id": 713, "name": "Schema" }, { "type": "reference", - "id": 687, + "id": 714, "name": "Row" }, { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, { @@ -16622,7 +17559,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 615, + "id": 631, "name": "default" } } @@ -16652,7 +17589,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 654, + "id": 681, "name": "default" } } @@ -16697,7 +17634,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 491, + "id": 499, "name": "default" } } @@ -16718,17 +17655,17 @@ { "title": "Classes", "kind": 128, - "children": [615, 9, 654, 151, 64, 491] + "children": [631, 9, 681, 151, 64, 499] }, { "title": "Interfaces", "kind": 256, - "children": [668, 674] + "children": [695, 701] }, { "title": "Type Aliases", "kind": 4194304, - "children": [683, 666, 681, 685] + "children": [710, 693, 708, 712] }, { "title": "Variables", diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json index 9f135c5ead2..b5bebe13e51 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 616, + "id": 632, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -24,27 +24,27 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 23, + "line": 31, "character": 2 } ], "signatures": [ { - "id": 617, + "id": 633, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 618, + "id": 634, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 619, + "id": 635, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -61,18 +61,18 @@ ], "parameters": [ { - "id": 620, + "id": 636, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -82,7 +82,7 @@ ], "name": "default", "dereferenced": { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -94,36 +94,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -141,7 +141,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -153,7 +153,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -162,11 +162,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -174,11 +174,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -197,16 +197,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -216,7 +216,7 @@ ] }, { - "id": 625, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -227,7 +227,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -237,7 +237,7 @@ } }, { - "id": 628, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -247,28 +247,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 630, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 631, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -292,7 +292,7 @@ } }, { - "id": 632, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -327,7 +327,7 @@ } }, { - "id": 623, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -337,7 +337,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -359,7 +359,7 @@ } }, { - "id": 633, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -369,7 +369,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -379,7 +379,7 @@ } }, { - "id": 621, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -389,7 +389,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -420,7 +420,7 @@ } }, { - "id": 624, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -431,7 +431,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -441,7 +441,7 @@ } }, { - "id": 626, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -451,7 +451,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -462,7 +462,7 @@ "defaultValue": "false" }, { - "id": 627, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -473,7 +473,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -485,7 +485,7 @@ } }, { - "id": 622, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -495,7 +495,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -507,7 +507,346 @@ } }, { - "id": 636, + "id": 671, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 672, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 673, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 678, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 674, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 675, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [675] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 676, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 677, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [677] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 668, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 669, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with" + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 670, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -515,13 +854,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 637, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -531,7 +870,7 @@ }, "parameters": [ { - "id": 638, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -542,7 +881,7 @@ } }, { - "id": 639, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -555,16 +894,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -574,7 +913,7 @@ ] }, { - "id": 640, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -582,20 +921,20 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 641, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 642, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -604,7 +943,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -613,11 +952,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -625,11 +964,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -638,7 +977,7 @@ } }, { - "id": 643, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -651,7 +990,7 @@ ], "parameters": [ { - "id": 644, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -668,21 +1007,21 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 646, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 647, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -691,7 +1030,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -700,11 +1039,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -712,11 +1051,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -756,7 +1095,7 @@ } }, { - "id": 648, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -773,21 +1112,21 @@ { "type": "reflection", "declaration": { - "id": 649, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 650, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -864,7 +1203,7 @@ } }, { - "id": 634, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -872,13 +1211,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 635, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -892,16 +1231,16 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -909,11 +1248,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -933,36 +1272,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -980,7 +1319,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -992,7 +1331,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -1001,11 +1340,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -1013,11 +1352,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -2409,7 +2748,7 @@ ] }, { - "id": 654, + "id": 681, "name": "PostgrestError", "kind": 128, "kindString": "Class", @@ -2420,7 +2759,7 @@ }, "children": [ { - "id": 655, + "id": 682, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2434,14 +2773,14 @@ ], "signatures": [ { - "id": 656, + "id": 683, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 657, + "id": 684, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -2449,14 +2788,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 662, + "id": 689, "name": "code", "kind": 1024, "kindString": "Property", @@ -2474,7 +2813,7 @@ } }, { - "id": 660, + "id": 687, "name": "details", "kind": 1024, "kindString": "Property", @@ -2492,7 +2831,7 @@ } }, { - "id": 661, + "id": 688, "name": "hint", "kind": 1024, "kindString": "Property", @@ -2510,7 +2849,7 @@ } }, { - "id": 659, + "id": 686, "name": "message", "kind": 1024, "kindString": "Property", @@ -2532,7 +2871,7 @@ { "title": "Properties", "kind": 1024, - "children": [662, 660, 661, 659] + "children": [689, 687, 688, 686] } ] } @@ -2541,7 +2880,7 @@ ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" }, "overwrites": { @@ -2556,7 +2895,7 @@ } }, { - "id": 665, + "id": 692, "name": "code", "kind": 1024, "kindString": "Property", @@ -2574,7 +2913,7 @@ } }, { - "id": 663, + "id": 690, "name": "details", "kind": 1024, "kindString": "Property", @@ -2592,7 +2931,7 @@ } }, { - "id": 664, + "id": 691, "name": "hint", "kind": 1024, "kindString": "Property", @@ -2614,12 +2953,12 @@ { "title": "Constructors", "kind": 512, - "children": [655] + "children": [682] }, { "title": "Properties", "kind": 1024, - "children": [665, 663, 664] + "children": [692, 690, 691] } ], "sources": [ @@ -2732,7 +3071,7 @@ "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -2746,7 +3085,7 @@ ], "name": "default", "dereferenced": { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -2755,7 +3094,7 @@ }, "children": [ { - "id": 616, + "id": 632, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2763,27 +3102,27 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 23, + "line": 31, "character": 2 } ], "signatures": [ { - "id": 617, + "id": 633, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 618, + "id": 634, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 619, + "id": 635, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -2800,18 +3139,18 @@ ], "parameters": [ { - "id": 620, + "id": 636, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -2826,16 +3165,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -2845,7 +3184,7 @@ ] }, { - "id": 625, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -2856,7 +3195,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -2866,7 +3205,7 @@ } }, { - "id": 628, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -2876,28 +3215,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 630, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 631, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2921,7 +3260,7 @@ } }, { - "id": 632, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2956,7 +3295,7 @@ } }, { - "id": 623, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2966,7 +3305,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -2988,7 +3327,7 @@ } }, { - "id": 633, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -2998,7 +3337,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -3008,7 +3347,7 @@ } }, { - "id": 621, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -3018,7 +3357,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -3049,7 +3388,7 @@ } }, { - "id": 624, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -3060,7 +3399,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -3070,7 +3409,7 @@ } }, { - "id": 626, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -3080,7 +3419,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -3091,7 +3430,7 @@ "defaultValue": "false" }, { - "id": 627, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -3102,7 +3441,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -3114,7 +3453,7 @@ } }, { - "id": 622, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -3124,7 +3463,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -3136,7 +3475,346 @@ } }, { - "id": 636, + "id": 671, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 672, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 673, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 678, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 674, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 675, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [675] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 676, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 677, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [677] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 668, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 669, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with" + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 670, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -3144,13 +3822,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 637, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -3160,7 +3838,7 @@ }, "parameters": [ { - "id": 638, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -3171,7 +3849,7 @@ } }, { - "id": 639, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3184,16 +3862,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -3203,7 +3881,7 @@ ] }, { - "id": 640, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -3211,20 +3889,20 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 641, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 642, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -3233,7 +3911,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -3242,11 +3920,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -3254,11 +3932,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -3267,7 +3945,7 @@ } }, { - "id": 643, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -3280,7 +3958,7 @@ ], "parameters": [ { - "id": 644, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -3297,21 +3975,21 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 646, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 647, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3320,7 +3998,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -3329,11 +4007,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -3341,11 +4019,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -3385,7 +4063,7 @@ } }, { - "id": 648, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -3402,21 +4080,21 @@ { "type": "reflection", "declaration": { - "id": 649, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 650, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -3493,7 +4171,7 @@ } }, { - "id": 634, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -3501,13 +4179,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 635, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -3521,16 +4199,16 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -3538,11 +4216,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -3562,36 +4240,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -3609,7 +4287,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -3621,7 +4299,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -3630,11 +4308,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -3642,11 +4320,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -3697,14 +4375,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 493, + "id": 501, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 492, + "id": 500, "name": "default.constructor" } }, @@ -3720,7 +4398,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -3730,7 +4408,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 583, + "id": 591, "name": "default.body" } }, @@ -3745,7 +4423,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], @@ -3825,7 +4503,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 586, + "id": 594, "name": "default.fetch" } }, @@ -3840,7 +4518,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -3862,7 +4540,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 589, "name": "default.headers" } }, @@ -3877,7 +4555,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -3887,7 +4565,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 591, + "id": 599, "name": "default.isMaybeSingle" } }, @@ -3902,7 +4580,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -3933,7 +4611,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 587, "name": "default.method" } }, @@ -3949,7 +4627,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -3959,7 +4637,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 582, + "id": 590, "name": "default.schema" } }, @@ -3974,7 +4652,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -3985,7 +4663,7 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 584, + "id": 592, "name": "default.shouldThrowOnError" } }, @@ -4001,7 +4679,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -4013,7 +4691,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 585, + "id": 593, "name": "default.signal" } }, @@ -4028,7 +4706,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -4040,7 +4718,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 588, "name": "default.url" } }, @@ -4119,14 +4797,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 552, + "id": 560, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 551, + "id": 559, "name": "default.abortSignal" } }, @@ -4651,7 +5329,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -4666,14 +5344,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 561, + "id": 569, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 560, + "id": 568, "name": "default.csv" } }, @@ -5062,7 +5740,7 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -5077,7 +5755,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "array", @@ -5109,14 +5787,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 565, + "id": 573, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 564, + "id": 572, "name": "default.explain" } }, @@ -5443,7 +6121,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -5470,14 +6148,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 563, + "id": 571, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 562, + "id": 570, "name": "default.geojson" } }, @@ -7532,14 +8210,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 537, + "id": 545, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 536, + "id": 544, "name": "default.limit" } }, @@ -8148,7 +8826,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "union", @@ -8173,14 +8851,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 558, + "id": 566, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 557, + "id": 565, "name": "default.maybeSingle" } }, @@ -8906,7 +9584,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 506, + "id": 514, "name": "default.order" } }, @@ -9070,7 +9748,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 514, + "id": 522, "name": "default.order" } }, @@ -9246,7 +9924,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 521, + "id": 529, "name": "default.order" } }, @@ -9407,14 +10085,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 529, + "id": 537, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 505, + "id": 513, "name": "default.order" } }, @@ -9634,6 +10312,282 @@ } ] }, + { + "id": 486, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 487, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 488, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 493, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 489, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 490, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [490] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 491, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 492, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [492] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 619, + "name": "default.overrideTypes" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 618, + "name": "default.overrideTypes" + } + }, { "id": 419, "name": "range", @@ -9798,14 +10752,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 544, + "id": 552, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 543, + "id": 551, "name": "default.range" } }, @@ -10693,7 +11647,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 311, + "line": 312, "character": 2 } ], @@ -10705,7 +11659,13 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`." + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] }, "typeParameter": [ { @@ -10715,13 +11675,13 @@ "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with\n" + "shortText": "The new result type to override with" } } ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -10735,8 +11695,19 @@ }, { "type": "reference", - "id": 454, - "name": "NewResult" + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 454, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" }, { "type": "reference", @@ -10753,14 +11724,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 585, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 576, + "id": 584, "name": "default.returns" } }, @@ -10822,14 +11793,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 575, + "id": 583, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 574, + "id": 582, "name": "default.rollback" } }, @@ -10881,7 +11852,7 @@ "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", @@ -10935,7 +11906,7 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -10970,14 +11941,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 501, + "id": 509, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 500, + "id": 508, "name": "default.select" } }, @@ -10990,7 +11961,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], @@ -11062,14 +12033,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 595, + "id": 603, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 594, + "id": 602, "name": "default.setHeader" } }, @@ -11131,7 +12102,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -11147,14 +12118,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 555, + "id": 563, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 554, + "id": 562, "name": "default.single" } }, @@ -11522,7 +12493,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], @@ -11542,7 +12513,7 @@ "flags": {}, "default": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", @@ -11605,7 +12576,7 @@ "flags": {}, "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", @@ -11746,14 +12717,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 599, + "id": 607, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 598, + "id": 606, "name": "default.then" } }, @@ -11766,7 +12737,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], @@ -11818,7 +12789,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -11836,14 +12807,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 593, + "id": 601, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 592, + "id": 600, "name": "default.throwOnError" } } @@ -11864,8 +12835,8 @@ "kind": 2048, "children": [ 427, 271, 263, 436, 160, 440, 366, 438, 170, 178, 226, 234, 242, 258, 250, 202, 210, - 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 419, 311, 279, 287, 295, 303, - 452, 450, 376, 470, 430, 327, 474, 468 + 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 486, 419, 311, 279, 287, 295, + 303, 452, 450, 376, 470, 430, 327, 474, 468 ] } ], @@ -11878,7 +12849,7 @@ ], "typeParameter": [ { - "id": 486, + "id": 494, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -11889,7 +12860,7 @@ } }, { - "id": 487, + "id": 495, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -11912,14 +12883,14 @@ } }, { - "id": 488, + "id": 496, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 489, + "id": 497, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -11930,7 +12901,7 @@ } }, { - "id": 490, + "id": 498, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -11944,7 +12915,7 @@ "extendedTypes": [ { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", @@ -13042,7 +14013,7 @@ "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", @@ -14000,28 +14971,28 @@ ] }, { - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 492, + "id": 500, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 493, + "id": 501, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 494, + "id": 502, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -14032,7 +15003,7 @@ } }, { - "id": 495, + "id": 503, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14055,14 +15026,14 @@ } }, { - "id": 496, + "id": 504, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 497, + "id": 505, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -14073,7 +15044,7 @@ } }, { - "id": 498, + "id": 506, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -14086,18 +15057,18 @@ ], "parameters": [ { - "id": 499, + "id": 507, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { @@ -14107,7 +15078,7 @@ ], "name": "default", "dereferenced": { - "id": 615, + "id": 631, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -14116,7 +15087,7 @@ }, "children": [ { - "id": 616, + "id": 632, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -14124,27 +15095,27 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 23, + "line": 31, "character": 2 } ], "signatures": [ { - "id": 617, + "id": 633, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 618, + "id": 634, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 619, + "id": 635, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -14161,18 +15132,18 @@ ], "parameters": [ { - "id": 620, + "id": 636, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -14187,16 +15158,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -14206,7 +15177,7 @@ ] }, { - "id": 625, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -14217,7 +15188,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -14227,7 +15198,7 @@ } }, { - "id": 628, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -14237,28 +15208,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 630, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 631, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -14282,7 +15253,7 @@ } }, { - "id": 632, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -14317,7 +15288,7 @@ } }, { - "id": 623, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -14327,7 +15298,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -14349,7 +15320,7 @@ } }, { - "id": 633, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -14359,7 +15330,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -14369,7 +15340,7 @@ } }, { - "id": 621, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -14379,7 +15350,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -14410,7 +15381,7 @@ } }, { - "id": 624, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -14421,7 +15392,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -14431,7 +15402,7 @@ } }, { - "id": 626, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -14441,7 +15412,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -14452,7 +15423,7 @@ "defaultValue": "false" }, { - "id": 627, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -14463,7 +15434,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -14475,7 +15446,7 @@ } }, { - "id": 622, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -14485,7 +15456,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -14497,7 +15468,346 @@ } }, { - "id": 636, + "id": 671, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 672, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 673, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 678, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 674, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 675, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [675] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 676, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 677, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [677] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 668, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 669, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with" + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 634, + "name": "Result" + }, + { + "type": "reference", + "id": 670, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 635, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -14505,13 +15815,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 637, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -14521,7 +15831,7 @@ }, "parameters": [ { - "id": 638, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -14532,7 +15842,7 @@ } }, { - "id": 639, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -14545,16 +15855,16 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -14564,7 +15874,7 @@ ] }, { - "id": 640, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -14572,20 +15882,20 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 641, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 642, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -14594,7 +15904,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -14603,11 +15913,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -14615,11 +15925,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -14628,7 +15938,7 @@ } }, { - "id": 643, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -14641,7 +15951,7 @@ ], "parameters": [ { - "id": 644, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -14658,21 +15968,21 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 646, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 647, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -14681,7 +15991,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -14690,11 +16000,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -14702,11 +16012,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -14746,7 +16056,7 @@ } }, { - "id": 648, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -14763,21 +16073,21 @@ { "type": "reflection", "declaration": { - "id": 649, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 650, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -14854,7 +16164,7 @@ } }, { - "id": 634, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -14862,13 +16172,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 635, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -14882,16 +16192,16 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" } ], @@ -14899,11 +16209,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" }, { @@ -14923,36 +16233,36 @@ { "title": "Constructors", "kind": 512, - "children": [616] + "children": [632] }, { "title": "Properties", "kind": 1024, - "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", "kind": 2048, - "children": [636, 640, 634] + "children": [671, 668, 652, 656, 650] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 7, + "line": 15, "character": 30 } ], "typeParameter": [ { - "id": 652, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 653, + "id": 680, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -14970,7 +16280,7 @@ "extendedBy": [ { "type": "reference", - "id": 491, + "id": 499, "name": "PostgrestTransformBuilder" } ], @@ -14982,7 +16292,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 619, + "id": 635, "name": "ThrowOnError" }, "extendsType": { @@ -14991,11 +16301,11 @@ }, "trueType": { "type": "reference", - "id": 674, + "id": 701, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -15003,11 +16313,11 @@ }, "falseType": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 618, + "id": 634, "name": "Result" } ], @@ -15026,31 +16336,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -15058,19 +16368,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 617, + "id": 633, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 616, + "id": 632, "name": "default.constructor" } }, { - "id": 583, + "id": 591, "name": "body", "kind": 1024, "kindString": "Property", @@ -15081,7 +16391,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 25, "character": 12 } ], @@ -15091,12 +16401,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 625, + "id": 641, "name": "default.body" } }, { - "id": 586, + "id": 594, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -15106,28 +16416,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 587, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 588, + "id": 596, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 589, + "id": 597, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -15151,7 +16461,7 @@ } }, { - "id": 590, + "id": 598, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -15186,12 +16496,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 628, + "id": 644, "name": "default.fetch" } }, { - "id": 581, + "id": 589, "name": "headers", "kind": 1024, "kindString": "Property", @@ -15201,7 +16511,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 15, + "line": 23, "character": 12 } ], @@ -15223,12 +16533,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 623, + "id": 639, "name": "default.headers" } }, { - "id": 591, + "id": 599, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -15238,7 +16548,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 21, + "line": 29, "character": 12 } ], @@ -15248,12 +16558,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 633, + "id": 649, "name": "default.isMaybeSingle" } }, { - "id": 579, + "id": 587, "name": "method", "kind": 1024, "kindString": "Property", @@ -15263,7 +16573,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 13, + "line": 21, "character": 12 } ], @@ -15294,12 +16604,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 621, + "id": 637, "name": "default.method" } }, { - "id": 582, + "id": 590, "name": "schema", "kind": 1024, "kindString": "Property", @@ -15310,7 +16620,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 16, + "line": 24, "character": 12 } ], @@ -15320,12 +16630,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 624, + "id": 640, "name": "default.schema" } }, { - "id": 584, + "id": 592, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -15335,7 +16645,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 26, "character": 12 } ], @@ -15346,12 +16656,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 626, + "id": 642, "name": "default.shouldThrowOnError" } }, { - "id": 585, + "id": 593, "name": "signal", "kind": 1024, "kindString": "Property", @@ -15362,7 +16672,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 19, + "line": 27, "character": 12 } ], @@ -15374,12 +16684,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 627, + "id": 643, "name": "default.signal" } }, { - "id": 580, + "id": 588, "name": "url", "kind": 1024, "kindString": "Property", @@ -15389,7 +16699,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 22, "character": 12 } ], @@ -15401,12 +16711,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 622, + "id": 638, "name": "default.url" } }, { - "id": 551, + "id": 559, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -15420,7 +16730,7 @@ ], "signatures": [ { - "id": 552, + "id": 560, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -15430,7 +16740,7 @@ }, "parameters": [ { - "id": 553, + "id": 561, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -15448,31 +16758,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -15482,7 +16792,7 @@ ] }, { - "id": 560, + "id": 568, "name": "csv", "kind": 2048, "kindString": "Method", @@ -15496,7 +16806,7 @@ ], "signatures": [ { - "id": 561, + "id": 569, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -15506,7 +16816,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -15523,7 +16833,7 @@ ] }, { - "id": 564, + "id": 572, "name": "explain", "kind": 2048, "kindString": "Method", @@ -15537,7 +16847,7 @@ ], "signatures": [ { - "id": 565, + "id": 573, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -15548,7 +16858,7 @@ }, "parameters": [ { - "id": 566, + "id": 574, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15560,14 +16870,14 @@ "type": { "type": "reflection", "declaration": { - "id": 567, + "id": 575, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 576, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -15590,7 +16900,7 @@ } }, { - "id": 571, + "id": 579, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -15613,7 +16923,7 @@ } }, { - "id": 573, + "id": 581, "name": "format", "kind": 1024, "kindString": "Property", @@ -15645,7 +16955,7 @@ } }, { - "id": 570, + "id": 578, "name": "settings", "kind": 1024, "kindString": "Property", @@ -15668,7 +16978,7 @@ } }, { - "id": 569, + "id": 577, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -15691,7 +17001,7 @@ } }, { - "id": 572, + "id": 580, "name": "wal", "kind": 1024, "kindString": "Property", @@ -15718,7 +17028,7 @@ { "title": "Properties", "kind": 1024, - "children": [568, 571, 573, 570, 569, 572] + "children": [576, 579, 581, 578, 577, 580] } ] } @@ -15731,7 +17041,7 @@ "types": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "intrinsic", @@ -15746,7 +17056,7 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "array", @@ -15780,7 +17090,7 @@ ] }, { - "id": 562, + "id": 570, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -15794,7 +17104,7 @@ ], "signatures": [ { - "id": 563, + "id": 571, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -15804,7 +17114,7 @@ }, "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -15833,7 +17143,7 @@ ] }, { - "id": 536, + "id": 544, "name": "limit", "kind": 2048, "kindString": "Method", @@ -15847,7 +17157,7 @@ ], "signatures": [ { - "id": 537, + "id": 545, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -15857,7 +17167,7 @@ }, "parameters": [ { - "id": 538, + "id": 546, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -15870,931 +17180,6 @@ "name": "number" } }, - { - "id": 539, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 9 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 32 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [541, 542] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 557, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 2 - } - ], - "signatures": [ - { - "id": 558, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "typeParameter": [ - { - "id": 559, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 496, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "id": 615, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 435, - "name": "ResultOne" - } - ] - }, - { - "type": "literal", - "value": false - } - ], - "name": "default" - } - } - ] - }, - { - "id": 505, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 506, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" - }, - "typeParameter": [ - { - "id": 507, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 508, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 383, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 509, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 511, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 512, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 513, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a referenced table by\nits columns" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [511, 512, 513] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 514, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" - }, - "parameters": [ - { - "id": 515, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 516, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 517, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 518, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 519, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 520, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a referenced table by\nits columns" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 61, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [518, 519, 520] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 521, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" - } - ] - }, - "typeParameter": [ - { - "id": 522, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 523, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 398, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 524, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 528, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 527, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 68, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [526, 528, 527] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 529, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" - } - ] - }, - "parameters": [ - { - "id": 530, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 531, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 533, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 535, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 75, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [533, 535, 534] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 491, - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "Schema" - }, - { - "type": "reference", - "id": 495, - "name": "Row" - }, - { - "type": "reference", - "id": 496, - "name": "Result" - }, - { - "type": "reference", - "id": 497, - "name": "RelationName" - }, - { - "type": "reference", - "id": 498, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 543, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 158, - "character": 2 - } - ], - "signatures": [ - { - "id": 544, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." - }, - "parameters": [ - { - "id": 545, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 546, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, { "id": 547, "name": "options", @@ -16828,7 +17213,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 164, + "line": 136, "character": 9 } ], @@ -16848,6 +17233,1207 @@ "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 136, + "character": 32 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [549, 550] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 565, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 204, + "character": 2 + } + ], + "signatures": [ + { + "id": 566, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + }, + "typeParameter": [ + { + "id": 567, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 504, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 435, + "name": "ResultOne" + } + ] + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + } + } + ] + }, + { + "id": 513, + "name": "order", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 514, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + }, + "typeParameter": [ + { + "id": 515, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 516, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 517, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 518, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 519, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 520, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 521, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a referenced table by\nits columns" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 57, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [519, 520, 521] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 522, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + }, + "parameters": [ + { + "id": 523, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 524, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 525, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 526, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 527, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 528, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a referenced table by\nits columns" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 61, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [526, 527, 528] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 529, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", + "tags": [ + { + "tag": "deprecated", + "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + } + ] + }, + "typeParameter": [ + { + "id": 530, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 531, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 398, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 532, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 533, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 534, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 536, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + }, + { + "id": 535, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 68, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [534, 536, 535] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 537, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", + "tags": [ + { + "tag": "deprecated", + "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + } + ] + }, + "parameters": [ + { + "id": 538, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 539, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 540, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 541, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 543, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 542, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 75, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [541, 543, 542] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 499, + "typeArguments": [ + { + "type": "reference", + "id": 502, + "name": "Schema" + }, + { + "type": "reference", + "id": 503, + "name": "Row" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 505, + "name": "RelationName" + }, + { + "type": "reference", + "id": 506, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 618, + "name": "overrideTypes", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 257, + "character": 2 + } + ], + "signatures": [ + { + "id": 619, + "name": "overrideTypes", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data` field in the response.", + "returns": "A PostgrestBuilder instance with the new type\n", + "tags": [ + { + "tag": "example", + "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + "typeParameter": [ + { + "id": 620, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new type to cast the response data to" + } + }, + { + "id": 625, + "name": "Options", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Optional type configuration (defaults to { merge: true })" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 621, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 622, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [622] + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 623, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 624, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 259, + "character": 44 + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [624] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 631, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 488, + "name": "NewResult" + }, + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 493, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 488, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 672, + "name": "default.overrideTypes" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 671, + "name": "default.overrideTypes" + } + }, + { + "id": 551, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 158, + "character": 2 + } + ], + "signatures": [ + { + "id": 552, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + }, + "parameters": [ + { + "id": 553, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 554, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 555, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 556, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 557, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 164, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 558, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", @@ -16865,7 +18451,7 @@ { "title": "Properties", "kind": 1024, - "children": [549, 550] + "children": [557, 558] } ] } @@ -16875,31 +18461,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -16909,7 +18495,7 @@ ] }, { - "id": 576, + "id": 584, "name": "returns", "kind": 2048, "kindString": "Method", @@ -16917,69 +18503,96 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 311, + "line": 312, "character": 2 } ], "signatures": [ { - "id": 577, + "id": 585, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`." + "shortText": "Override the type of the returned `data`.", + "tags": [ + { + "tag": "deprecated", + "text": "Use overrideTypes() method at the end of your call chain instead\n" + } + ] }, "typeParameter": [ { - "id": 578, + "id": 586, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with\n" + "shortText": "The new result type to override with" } } ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 454, - "name": "NewResult" + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "Result" + }, + { + "type": "reference", + "id": 454, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], "name": "default" + }, + "overwrites": { + "type": "reference", + "id": 669, + "name": "default.returns" } } - ] + ], + "overwrites": { + "type": "reference", + "id": 668, + "name": "default.returns" + } }, { - "id": 574, + "id": 582, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -16993,7 +18606,7 @@ ], "signatures": [ { - "id": 575, + "id": 583, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -17004,31 +18617,31 @@ }, "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -17038,7 +18651,7 @@ ] }, { - "id": 500, + "id": 508, "name": "select", "kind": 2048, "kindString": "Method", @@ -17052,7 +18665,7 @@ ], "signatures": [ { - "id": 501, + "id": 509, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -17063,7 +18676,7 @@ }, "typeParameter": [ { - "id": 502, + "id": 510, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -17078,33 +18691,33 @@ } }, { - "id": 503, + "id": 511, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 685, + "id": 712, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" }, { @@ -17119,7 +18732,7 @@ ], "parameters": [ { - "id": 504, + "id": 512, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -17139,16 +18752,16 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { @@ -17161,12 +18774,12 @@ }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -17176,7 +18789,7 @@ ] }, { - "id": 594, + "id": 602, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -17184,13 +18797,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 56, + "line": 64, "character": 2 } ], "signatures": [ { - "id": 595, + "id": 603, "name": "setHeader", "kind": 4096, "kindString": "Call signature", @@ -17200,7 +18813,7 @@ }, "parameters": [ { - "id": 596, + "id": 604, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -17211,7 +18824,7 @@ } }, { - "id": 597, + "id": 605, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -17224,31 +18837,31 @@ ], "type": { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -17256,19 +18869,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 637, + "id": 653, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 636, + "id": 652, "name": "default.setHeader" } }, { - "id": 554, + "id": 562, "name": "single", "kind": 2048, "kindString": "Method", @@ -17282,7 +18895,7 @@ ], "signatures": [ { - "id": 555, + "id": 563, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -17293,7 +18906,7 @@ }, "typeParameter": [ { - "id": 556, + "id": 564, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -17302,7 +18915,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, "extendsType": { @@ -17325,7 +18938,7 @@ ], "type": { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", @@ -17343,7 +18956,7 @@ ] }, { - "id": 598, + "id": 606, "name": "then", "kind": 2048, "kindString": "Method", @@ -17351,31 +18964,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 62, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 599, + "id": 607, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 600, + "id": 608, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -17383,7 +18996,7 @@ } }, { - "id": 601, + "id": 609, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -17396,7 +19009,7 @@ ], "parameters": [ { - "id": 602, + "id": 610, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -17413,32 +19026,32 @@ { "type": "reflection", "declaration": { - "id": 603, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 604, + "id": 612, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 605, + "id": 613, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -17477,7 +19090,7 @@ } }, { - "id": 606, + "id": 614, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -17494,21 +19107,21 @@ { "type": "reflection", "declaration": { - "id": 607, + "id": 615, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 608, + "id": 616, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 609, + "id": 617, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -17575,19 +19188,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 641, + "id": 657, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 640, + "id": 656, "name": "default.then" } }, { - "id": 592, + "id": 600, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -17595,13 +19208,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 48, + "line": 56, "character": 2 } ], "signatures": [ { - "id": 593, + "id": 601, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -17615,31 +19228,31 @@ "types": [ { "type": "reference", - "id": 491, + "id": 499, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 502, "name": "Schema" }, { "type": "reference", - "id": 495, + "id": 503, "name": "Row" }, { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { "type": "reference", - "id": 497, + "id": 505, "name": "RelationName" }, { "type": "reference", - "id": 498, + "id": 506, "name": "Relationships" } ], @@ -17647,11 +19260,11 @@ }, { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" }, { @@ -17665,14 +19278,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 635, + "id": 651, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 634, + "id": 650, "name": "default.throwOnError" } } @@ -17681,17 +19294,19 @@ { "title": "Constructors", "kind": 512, - "children": [492] + "children": [500] }, { "title": "Properties", "kind": 1024, - "children": [583, 586, 581, 591, 579, 582, 584, 585, 580] + "children": [591, 594, 589, 599, 587, 590, 592, 593, 588] }, { "title": "Methods", "kind": 2048, - "children": [551, 560, 564, 562, 536, 557, 505, 543, 576, 574, 500, 594, 554, 598, 592] + "children": [ + 559, 568, 572, 570, 544, 565, 513, 618, 551, 584, 582, 508, 602, 562, 606, 600 + ] } ], "sources": [ @@ -17703,7 +19318,7 @@ ], "typeParameter": [ { - "id": 610, + "id": 626, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -17714,7 +19329,7 @@ } }, { - "id": 611, + "id": 627, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -17737,14 +19352,14 @@ } }, { - "id": 612, + "id": 628, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 613, + "id": 629, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -17755,7 +19370,7 @@ } }, { - "id": 614, + "id": 630, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -17769,11 +19384,11 @@ "extendedTypes": [ { "type": "reference", - "id": 615, + "id": 631, "typeArguments": [ { "type": "reference", - "id": 496, + "id": 504, "name": "Result" } ], @@ -17789,18 +19404,54 @@ ] }, { - "id": 668, + "id": 695, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 671, + "id": 698, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 697, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 696, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -17808,48 +19459,12 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 669, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 20, - "character": 2 - } - ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default", "dereferenced": { - "id": 654, + "id": 681, "name": "PostgrestError", "kind": 128, "kindString": "Class", @@ -17860,7 +19475,7 @@ }, "children": [ { - "id": 655, + "id": 682, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -17874,14 +19489,14 @@ ], "signatures": [ { - "id": 656, + "id": 683, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 657, + "id": 684, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -17889,14 +19504,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 662, + "id": 689, "name": "code", "kind": 1024, "kindString": "Property", @@ -17914,7 +19529,7 @@ } }, { - "id": 660, + "id": 687, "name": "details", "kind": 1024, "kindString": "Property", @@ -17932,7 +19547,7 @@ } }, { - "id": 661, + "id": 688, "name": "hint", "kind": 1024, "kindString": "Property", @@ -17950,7 +19565,7 @@ } }, { - "id": 659, + "id": 686, "name": "message", "kind": 1024, "kindString": "Property", @@ -17972,7 +19587,7 @@ { "title": "Properties", "kind": 1024, - "children": [662, 660, 661, 659] + "children": [689, 687, 688, 686] } ] } @@ -17981,7 +19596,7 @@ ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" }, "overwrites": { @@ -17996,7 +19611,7 @@ } }, { - "id": 665, + "id": 692, "name": "code", "kind": 1024, "kindString": "Property", @@ -18014,7 +19629,7 @@ } }, { - "id": 663, + "id": 690, "name": "details", "kind": 1024, "kindString": "Property", @@ -18032,7 +19647,7 @@ } }, { - "id": 664, + "id": 691, "name": "hint", "kind": 1024, "kindString": "Property", @@ -18054,12 +19669,12 @@ { "title": "Constructors", "kind": 512, - "children": [655] + "children": [682] }, { "title": "Properties", "kind": 1024, - "children": [665, 663, 664] + "children": [692, 690, 691] } ], "sources": [ @@ -18081,7 +19696,7 @@ } }, { - "id": 672, + "id": 699, "name": "status", "kind": 1024, "kindString": "Property", @@ -18089,7 +19704,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -18103,7 +19718,7 @@ } }, { - "id": 673, + "id": 700, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -18111,7 +19726,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -18129,13 +19744,13 @@ { "title": "Properties", "kind": 1024, - "children": [671, 670, 669, 672, 673] + "children": [698, 697, 696, 699, 700] } ], "sources": [ { "fileName": "src/types.ts", - "line": 19, + "line": 21, "character": 17 } ], @@ -18147,14 +19762,14 @@ ] }, { - "id": 674, + "id": 701, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 677, + "id": 704, "name": "count", "kind": 1024, "kindString": "Property", @@ -18162,7 +19777,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 17, + "line": 19, "character": 2 } ], @@ -18181,7 +19796,7 @@ } }, { - "id": 676, + "id": 703, "name": "data", "kind": 1024, "kindString": "Property", @@ -18189,19 +19804,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 16, + "line": 18, "character": 2 } ], "type": { "type": "reference", - "id": 680, + "id": 707, "name": "T", "dereferenced": {} } }, { - "id": 675, + "id": 702, "name": "error", "kind": 1024, "kindString": "Property", @@ -18209,7 +19824,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 15, + "line": 17, "character": 2 } ], @@ -18219,7 +19834,7 @@ } }, { - "id": 678, + "id": 705, "name": "status", "kind": 1024, "kindString": "Property", @@ -18227,7 +19842,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -18241,7 +19856,7 @@ } }, { - "id": 679, + "id": 706, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -18249,7 +19864,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -18267,19 +19882,19 @@ { "title": "Properties", "kind": 1024, - "children": [677, 676, 675, 678, 679] + "children": [704, 703, 702, 705, 706] } ], "sources": [ { "fileName": "src/types.ts", - "line": 14, + "line": 16, "character": 17 } ], "typeParameter": [ { - "id": 680, + "id": 707, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -18294,7 +19909,7 @@ ] }, { - "id": 683, + "id": 710, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -18302,13 +19917,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 31, "character": 12 } ], "typeParameter": [ { - "id": 684, + "id": 711, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -18317,14 +19932,14 @@ ], "type": { "type": "reference", - "id": 681, + "id": 708, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 684, + "id": 711, "name": "T" }, { @@ -18338,11 +19953,49 @@ } }, { - "id": 666, + "id": 693, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 32, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 694, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 708, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "id": 694, + "name": "T" + } + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 708, + "name": "PostgrestSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -18352,45 +20005,7 @@ ], "typeParameter": [ { - "id": 667, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reference", - "id": 681, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 667, - "name": "T" - } - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 681, - "name": "PostgrestSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 28, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 682, + "id": 709, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -18401,14 +20016,14 @@ "type": "union", "types": [ { - "id": 674, + "id": 701, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 677, + "id": 704, "name": "count", "kind": 1024, "kindString": "Property", @@ -18416,7 +20031,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 17, + "line": 19, "character": 2 } ], @@ -18435,7 +20050,7 @@ } }, { - "id": 676, + "id": 703, "name": "data", "kind": 1024, "kindString": "Property", @@ -18443,19 +20058,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 16, + "line": 18, "character": 2 } ], "type": { "type": "reference", - "id": 680, + "id": 707, "name": "T", "dereferenced": {} } }, { - "id": 675, + "id": 702, "name": "error", "kind": 1024, "kindString": "Property", @@ -18463,7 +20078,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 15, + "line": 17, "character": 2 } ], @@ -18473,7 +20088,7 @@ } }, { - "id": 678, + "id": 705, "name": "status", "kind": 1024, "kindString": "Property", @@ -18481,7 +20096,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -18495,7 +20110,7 @@ } }, { - "id": 679, + "id": 706, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -18503,7 +20118,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -18521,19 +20136,19 @@ { "title": "Properties", "kind": 1024, - "children": [677, 676, 675, 678, 679] + "children": [704, 703, 702, 705, 706] } ], "sources": [ { "fileName": "src/types.ts", - "line": 14, + "line": 16, "character": 17 } ], "typeParameter": [ { - "id": 680, + "id": 707, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -18548,18 +20163,54 @@ ] }, { - "id": 668, + "id": 695, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 671, + "id": 698, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 697, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 696, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/types.ts", @@ -18567,48 +20218,12 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 669, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 20, - "character": 2 - } - ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default", "dereferenced": { - "id": 654, + "id": 681, "name": "PostgrestError", "kind": 128, "kindString": "Class", @@ -18619,7 +20234,7 @@ }, "children": [ { - "id": 655, + "id": 682, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -18633,14 +20248,14 @@ ], "signatures": [ { - "id": 656, + "id": 683, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 657, + "id": 684, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -18648,14 +20263,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 685, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 662, + "id": 689, "name": "code", "kind": 1024, "kindString": "Property", @@ -18673,7 +20288,7 @@ } }, { - "id": 660, + "id": 687, "name": "details", "kind": 1024, "kindString": "Property", @@ -18691,7 +20306,7 @@ } }, { - "id": 661, + "id": 688, "name": "hint", "kind": 1024, "kindString": "Property", @@ -18709,7 +20324,7 @@ } }, { - "id": 659, + "id": 686, "name": "message", "kind": 1024, "kindString": "Property", @@ -18731,7 +20346,7 @@ { "title": "Properties", "kind": 1024, - "children": [662, 660, 661, 659] + "children": [689, 687, 688, 686] } ] } @@ -18740,7 +20355,7 @@ ], "type": { "type": "reference", - "id": 654, + "id": 681, "name": "default" }, "overwrites": { @@ -18755,7 +20370,7 @@ } }, { - "id": 665, + "id": 692, "name": "code", "kind": 1024, "kindString": "Property", @@ -18773,7 +20388,7 @@ } }, { - "id": 663, + "id": 690, "name": "details", "kind": 1024, "kindString": "Property", @@ -18791,7 +20406,7 @@ } }, { - "id": 664, + "id": 691, "name": "hint", "kind": 1024, "kindString": "Property", @@ -18813,12 +20428,12 @@ { "title": "Constructors", "kind": 512, - "children": [655] + "children": [682] }, { "title": "Properties", "kind": 1024, - "children": [665, 663, 664] + "children": [692, 690, 691] } ], "sources": [ @@ -18840,7 +20455,7 @@ } }, { - "id": 672, + "id": 699, "name": "status", "kind": 1024, "kindString": "Property", @@ -18848,7 +20463,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 11, + "line": 13, "character": 2 } ], @@ -18862,7 +20477,7 @@ } }, { - "id": 673, + "id": 700, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -18870,7 +20485,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 12, + "line": 14, "character": 2 } ], @@ -18888,13 +20503,13 @@ { "title": "Properties", "kind": 1024, - "children": [671, 670, 669, 672, 673] + "children": [698, 697, 696, 699, 700] } ], "sources": [ { "fileName": "src/types.ts", - "line": 19, + "line": 21, "character": 17 } ], @@ -18909,7 +20524,7 @@ } }, { - "id": 685, + "id": 712, "name": "UnstableGetResult", "kind": 4194304, "kindString": "Type alias", @@ -18926,7 +20541,7 @@ ], "typeParameter": [ { - "id": 686, + "id": 713, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -18940,7 +20555,7 @@ } }, { - "id": 687, + "id": 714, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -18966,7 +20581,7 @@ } }, { - "id": 688, + "id": 715, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -18976,7 +20591,7 @@ } }, { - "id": 689, + "id": 716, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -18986,7 +20601,7 @@ } }, { - "id": 690, + "id": 717, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -19007,7 +20622,7 @@ "typeArguments": [ { "type": "reference", - "id": 686, + "id": 713, "name": "Schema" } ], @@ -19024,7 +20639,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -19051,7 +20666,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -19087,7 +20702,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, "extendsType": { @@ -19101,7 +20716,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -19135,7 +20750,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -19144,7 +20759,7 @@ }, "trueType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "falseType": { @@ -19154,7 +20769,7 @@ }, { "type": "reference", - "id": 687, + "id": 714, "name": "Row" } ], @@ -19167,7 +20782,7 @@ }, "falseType": { "type": "reference", - "id": 687, + "id": 714, "name": "Row" } }, @@ -19178,7 +20793,7 @@ "typeArguments": [ { "type": "reference", - "id": 690, + "id": 717, "name": "Query" } ], @@ -19205,7 +20820,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, "extendsType": { @@ -19216,7 +20831,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, "extendsType": { @@ -19231,22 +20846,22 @@ "typeArguments": [ { "type": "reference", - "id": 686, + "id": 713, "name": "Schema" }, { "type": "reference", - "id": 687, + "id": 714, "name": "Row" }, { "type": "reference", - "id": 688, + "id": 715, "name": "RelationName" }, { "type": "reference", - "id": 689, + "id": 716, "name": "Relationships" }, { @@ -19323,7 +20938,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 615, + "id": 631, "name": "default" } } @@ -19353,7 +20968,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 654, + "id": 681, "name": "default" } } @@ -19398,7 +21013,7 @@ "type": "query", "queryType": { "type": "reference", - "id": 491, + "id": 499, "name": "default" } } @@ -19419,17 +21034,17 @@ { "title": "Classes", "kind": 128, - "children": [615, 9, 654, 151, 64, 491] + "children": [631, 9, 681, 151, 64, 499] }, { "title": "Interfaces", "kind": 256, - "children": [668, 674] + "children": [695, 701] }, { "title": "Type Aliases", "kind": 4194304, - "children": [683, 666, 681, 685] + "children": [710, 693, 708, 712] }, { "title": "Variables", diff --git a/apps/docs/spec/storage_v0_openapi.json b/apps/docs/spec/storage_v0_openapi.json index 294aa475c84..edf934d462b 100644 --- a/apps/docs/spec/storage_v0_openapi.json +++ b/apps/docs/spec/storage_v0_openapi.json @@ -1219,6 +1219,31 @@ } } }, + "/object/list-v2/{bucketName}": { + "post": { + "summary": "Search for objects under a prefix", + "tags": ["object"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prefix": { "type": "string", "examples": ["folder/subfolder"] }, + "limit": { "type": "integer", "minimum": 1, "examples": [10] }, + "cursor": { "type": "string" }, + "with_delimiter": { "type": "boolean" } + } + } + } + } + }, + "parameters": [ + { "schema": { "type": "string" }, "in": "path", "name": "bucketName", "required": true } + ], + "responses": { "200": { "description": "Default Response" } } + } + }, "/object/list/{bucketName}": { "post": { "summary": "Search for objects under a prefix", diff --git a/apps/docs/spec/supabase_js_v2.yml b/apps/docs/spec/supabase_js_v2.yml index ae051e1225a..da4ea241ef4 100644 --- a/apps/docs/spec/supabase_js_v2.yml +++ b/apps/docs/spec/supabase_js_v2.yml @@ -6593,6 +6593,8 @@ functions: - id: returns $ref: '@supabase/postgrest-js.PostgrestTransformBuilder.returns' + notes: | + - Deprecated: use overrideTypes method instead title: returns() examples: - id: override-type-of-successful-response @@ -6602,6 +6604,22 @@ functions: const { data } = await supabase .from('countries') .select() + .returns>() + ``` + response: | + ``` + let x: typeof data // MyType[] + ``` + hideCodeBlock: true + isSpotlight: true + - id: override-type-of-object-response + name: Override type of object response + code: | + ```ts + const { data } = await supabase + .from('countries') + .select() + .maybeSingle() .returns() ``` response: | @@ -6611,6 +6629,73 @@ functions: hideCodeBlock: true isSpotlight: true + - id: overrideTypes + $ref: '@supabase/postgrest-js.PostgrestBuilder.overrideTypes' + title: overrideTypes() + examples: + - id: complete-override-type-of-successful-response + name: Complete Override type of successful response + code: | + ```ts + const { data } = await supabase + .from('countries') + .select() + .overrideTypes, { merge: false }>() + ``` + response: | + ```ts + let x: typeof data // MyType[] + ``` + hideCodeBlock: true + isSpotlight: true + - id: complete-override-type-of-object-response + name: Complete Override type of object response + code: | + ```ts + const { data } = await supabase + .from('countries') + .select() + .maybeSingle() + .overrideTypes() + ``` + response: | + ```ts + let x: typeof data // MyType | null + ``` + hideCodeBlock: true + isSpotlight: true + - id: partial-override-type-of-successful-response + name: Partial Override type of successful response + code: | + ```ts + const { data } = await supabase + .from('countries') + .select() + .overrideTypes>() + ``` + response: | + ```ts + let x: typeof data // Array + ``` + hideCodeBlock: true + isSpotlight: true + - id: partial-override-type-of-object-response + name: Partial Override type of object response + code: | + ```ts + const { data } = await supabase + .from('countries') + .select() + .maybeSingle() + .overrideTypes<{ status: "A" | "B" }>() + ``` + response: | + ```ts + let x: typeof data // CountryRowProperties & { status: "A" | "B" } | null + ``` + hideCodeBlock: true + isSpotlight: true + - id: explain $ref: '@supabase/postgrest-js.PostgrestTransformBuilder.explain' title: Using Explain diff --git a/apps/docs/spec/supabase_swift_v2.yml b/apps/docs/spec/supabase_swift_v2.yml index 45768e4754b..4c83fb45c73 100644 --- a/apps/docs/spec/supabase_swift_v2.yml +++ b/apps/docs/spec/supabase_swift_v2.yml @@ -26,7 +26,7 @@ functions: code: | ```swift import Supabase - + let client = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "public-anon-key") ``` - id: initialize-client-custom-options @@ -34,7 +34,7 @@ functions: code: | ```swift import Supabase - + let client = SupabaseClient( supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "public-anon-key", @@ -58,7 +58,7 @@ functions: code: | ```swift import Supabase - + struct AppLogger: SupabaseLogger { func log(message: SupabaseLogMessage) { print(message.description) @@ -80,7 +80,7 @@ functions: code: | ```swift import Supabase - + let supabase = SupabaseClient( supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "public-anon-key", diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json index 26c772546aa..853eed28c1e 100644 --- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json +++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json @@ -3592,6 +3592,9 @@ }, "value": { "type": "string" + }, + "updated_at": { + "type": "string" } }, "required": ["name", "value"] @@ -12284,6 +12287,9 @@ }, "value": { "type": "string" + }, + "updated_at": { + "type": "string" } }, "required": ["name", "value"] diff --git a/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json b/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json index 015db0229d7..642d78f9511 100644 --- a/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json +++ b/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json @@ -1874,6 +1874,53 @@ } } }, + "/object/list-v2/{bucketName}": { + "post": { + "summary": "Search for objects under a prefix", + "tags": ["object"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prefix": { + "type": "string", + "examples": ["folder/subfolder"] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [10] + }, + "cursor": { + "type": "string" + }, + "with_delimiter": { + "type": "boolean" + } + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "bucketName", + "required": true + } + ], + "responses": { + "200": { + "description": "Default Response" + } + } + } + }, "/object/list/{bucketName}": { "post": { "summary": "Search for objects under a prefix", From 1dc35dd9bb4efb5d31e8c87bfdacd25590eed28f Mon Sep 17 00:00:00 2001 From: Clarence Date: Mon, 3 Mar 2025 16:52:38 +0100 Subject: [PATCH 11/50] chore: updated Developers.md (#33933) * chore: change Git url from http --> https * chore: change nodejs url from http --> https --- DEVELOPERS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 26f40136c82..d9faa171b06 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -36,8 +36,8 @@ To ensure a positive and inclusive environment, please read our [code of conduct You will need to install and configure the following dependencies on your machine to build [Supabase](https://supabase.com): -- [Git](http://git-scm.com/) -- [Node.js v20.x (LTS)](http://nodejs.org) +- [Git](https://git-scm.com/) +- [Node.js v20.x (LTS)](https://nodejs.org) - [pnpm](https://pnpm.io/) version 9.x.x or higher - [make](https://www.gnu.org/software/make/) or the equivalent to `build-essentials` for your OS - [Docker](https://docs.docker.com/get-docker/) (to run studio locally) From 3e1cd0aac47569aab67910f0fa5598d6753721ce Mon Sep 17 00:00:00 2001 From: vuksanv <167647377+vuksanv@users.noreply.github.com> Date: Mon, 3 Mar 2025 11:15:44 -0500 Subject: [PATCH 12/50] Laravel documentation addition to explain schema needs to be created (#33973) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add a note that schema needs to exist on Supabase before running migrate. Otherwise one will receivie a following error $ php artisan migrate INFO Preparing database. Creating migration table ........................................................................................................... 599.73ms FAIL Illuminate\Database\QueryException SQLSTATE[3F000]: Invalid schema name: 7 ERROR: no schema has been selected to create in at character 14 (Connection: pgsql, SQL: create table "migrations" ("id" serial not null primary key, "migration" varchar(255) not null, "batch" integer not null)) at vendor/laravel/framework/src/Illuminate/Database/Connection.php:823 819▕ $this->getName(), $query, $this->prepareBindings($bindings), $e 820▕ ); 821▕ } 822▕ ➜ 823▕ throw new QueryException( 824▕ $this->getName(), $query, $this->prepareBindings($bindings), $e 825▕ ); 826▕ } 827▕ } +41 vendor frames 42 artisan:16 Illuminate\Foundation\Application::handleCommand() * Apply suggestions from code review --------- Co-authored-by: Vladimir Vuksan Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> --- .../docs/content/guides/getting-started/quickstarts/laravel.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx b/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx index cf2afe249aa..4fb0eca309b 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx @@ -77,6 +77,8 @@ hideToc: true You can change the schema of your Laravel application by modifying the `search_path` variable `app/config/database.php`. + Please note the schema you specify in `search_path` has to exist on Supabase. You can create a new schema from the [Table Editor](/dashboard/project/_/editor). + From c5c5bc231f5859dc69830ad1fcf83b85c530da54 Mon Sep 17 00:00:00 2001 From: Charis <26616127+charislam@users.noreply.github.com> Date: Mon, 3 Mar 2025 12:17:38 -0500 Subject: [PATCH 13/50] feat: support typedoc 0.27 (#33905) Type docs pulled from JS client libraries were expected to be in version 0.22, which unfortunately is a bit old and incompatible with TypeScript 5. Therefore any JS lib that upgrades their toolchian to TS 5 will inadvertently break their type specs in docs. This PR updates docs to also support 0.27 (the latest stable version, compatible with TS 5), in addition to the old version. Parallel support is required since many libs are still on the old version. The main changes are: - The comment shape has changed in typedoc. - kindString has been deprecated in favor the kind numbers. - indexSignatures are now plural (an array). --- apps/docs/features/docs/Reference.typeSpec.ts | 182 +- .../Reference.typeSpec.test.ts.snap | 512 +- apps/docs/spec/api_v1_openapi.json | 184 + .../spec/enrichments/tsdoc_v2/combined.json | 42472 +++------------- .../spec/enrichments/tsdoc_v2/realtime.json | 11810 +++-- .../tsdoc_v2/realtime_dereferenced.json | 42457 +++------------ .../transforms/api_v1_openapi_deparsed.json | 469 + 7 files changed, 24849 insertions(+), 73237 deletions(-) diff --git a/apps/docs/features/docs/Reference.typeSpec.ts b/apps/docs/features/docs/Reference.typeSpec.ts index 589ee7702f7..d20ecd44d05 100644 --- a/apps/docs/features/docs/Reference.typeSpec.ts +++ b/apps/docs/features/docs/Reference.typeSpec.ts @@ -155,6 +155,69 @@ export interface CustomTypePropertyType { type: TypeDetails | undefined } +/** + * + * New versions of `typedoc` added the variant property, so this is a quick and + * dirty way of checking version. + */ +function isNewTypedoc(node: any) { + return 'variant' in node +} + +/** + * + * The shape of a new `typedoc` comment. `typedoc` changed their Comment class + * in v0.23.0. + */ +interface TypedocComment { + summary: CommentKind[] + blockTags: CommentBlockTag[] +} + +type CommentKind = CommentKindText | CommentKindCode + +interface CommentKindText { + kind: 'text' + text: string +} + +interface CommentKindCode { + kind: 'code' + text: string +} + +interface CommentBlockTag { + /** + * An @ string, e.g., `@returns` + */ + tag: string + content: CommentKind[] +} + +function normalizeComment(original: TypedocComment | Comment): Comment { + if (!original) return + + if ('shortText' in original || 'text' in original) { + // This is the old comment type, just return it + return original + } + + let comment: Comment = {} + + if ('summary' in original) { + comment.shortText = original.summary.map((part) => part.text).join('') + } + + return comment +} + +// The meaning of kind flags from `typedoc`: +// https://github.com/TypeStrong/typedoc/blob/2953b0148253589448176881a7acb46090f941bd/src/lib/output/themes/default/assets/typedoc/Application.ts#L36 +const KIND_CLASS = 128 +const KIND_CONSTRUCTOR = 512 +const KIND_METHOD = 2048 +const KIND_TYPE_LITERAL = 65536 + export function parseTypeSpec() { const modules = (typeSpec.children ?? []).map(parseMod) return modules as Array @@ -200,30 +263,41 @@ function parseModInternal( ) { let updatedPath: Array - switch (node.kindString) { - case 'Module': + switch ((node.kindString ?? node.variant)?.toLowerCase()) { + case 'module': updatedPath = [...currentPath, node.name] node.children?.forEach((child: any) => parseModInternal(child, map, updatedPath, res)) return - // Some libraries have undefined where others have Project for the same type - // of top-level node. - case 'Project': + // Some libraries have undefined where others have Project or declaration // for the same type of top-level node. + case 'project': case undefined: updatedPath = [...currentPath, node.name] node.children?.forEach((child: any) => parseModInternal(child, map, updatedPath, res)) - case 'Class': + return + case 'class': updatedPath = [...currentPath, node.name] node.children?.forEach((child: any) => parseModInternal(child, map, updatedPath, res)) return - case 'Constructor': - parseConstructor(node, map, currentPath, res) - case 'Method': - parseMethod(node, map, currentPath, res) - case 'Interface': + case 'constructor': + return parseConstructor(node, map, currentPath, res) + case 'method': + return parseMethod(node, map, currentPath, res) + case 'interface': updatedPath = [...currentPath, node.name] node.children?.forEach((child: any) => parseModInternal(child, map, updatedPath, res)) - case 'Property': - case 'Reference': + return + case 'declaration': + if (node.kind === KIND_CLASS) { + updatedPath = [...currentPath, node.name] + node.children?.forEach((child: any) => parseModInternal(child, map, updatedPath, res)) + } else if (node.kind === KIND_CONSTRUCTOR) { + parseConstructor(node, map, currentPath, res) + } else if (node.kind === KIND_METHOD) { + return parseMethod(node, map, currentPath, res) + } + return + case 'property': + case 'reference': default: return undefined } @@ -321,7 +395,7 @@ function parseSignature( } if (param.comment) { - res.comment = param.comment + res.comment = normalizeComment(param.comment) } return res @@ -340,7 +414,7 @@ function parseSignature( return { params, ret, - comment: signature.comment, + comment: normalizeComment(signature.comment), } } @@ -407,8 +481,8 @@ function delegateParsing(original: any, referenced: any, map: Map) if (original.comment) { dereferencedType.comment = { - ...dereferencedType.comment, - ...original.comment, + ...normalizeComment(dereferencedType.comment), + ...normalizeComment(original.comment), } } @@ -424,22 +498,52 @@ function parseReferenceType(type: any, map: Map) { return delegateParsing(type, type.dereferenced, map) } - if (type.package === 'typescript' && type.qualifiedName === 'Record') { + if ( + type.package === 'typescript' && + (type.name === 'Record' || type.qualifiedName === 'Record') + ) { return parseRecordType(type, map) } - if (type.package === 'typescript' && type.qualifiedName === 'Promise') { + if ( + type.package === 'typescript' && + (type.name === 'Promise' || type.qualifiedName === 'Promise') + ) { return parsePromiseType(type, map) } - if (type.package === 'typescript' && type.qualifiedName === 'Extract') { + if ( + type.package === 'typescript' && + (type.name === 'Extract' || type.qualifiedName === 'Extract') + ) { return parseExtractType(type, map) } - if (type.package === 'typescript' && type.qualifiedName === 'Pick') { + if (type.package === 'typescript' && (type.name === 'Pick' || type.qualifiedName === 'Pick')) { return parsePickType(type, map) } + // If we still haven't produced a meaningful type, try looking up the reference + const referenced = map.get(type.id ?? type.target) // became target in newer versions of tsdoc + if (referenced) { + const maybeType = + typeof referenced.type === 'object' && 'type' in referenced.type + ? /* need to go down a level */ delegateParsing(type, referenced.type, map) + : delegateParsing(type, referenced, map) + + if (maybeType) { + return maybeType + } else if (isNewTypedoc(referenced) && referenced.kind === KIND_CLASS) { + // Class is too complicated to display here, just return its name + return { + type: 'nameOnly', + name: referenced.name, + } + } + } + + // We produced nothing, let's just return some strings in case they're in any + // way meaningful. if (type.package && type.qualifiedName) { return { type: 'nameOnly', @@ -454,19 +558,6 @@ function parseReferenceType(type: any, map: Map) { return parseType(type.typeArguments[0], map) } - // If we still haven't produced a meaningful type, try looking up the reference - const referenced = map.get(type.id) - if (referenced) { - const maybeType = - typeof referenced.type === 'object' && 'type' in referenced.type - ? /* need to go down a level */ delegateParsing(type, referenced.type, map) - : delegateParsing(type, referenced, map) - - if (maybeType) { - return maybeType - } - } - // Final fallback if (type.name && type.name !== 'default' /* Not particularly meaningful */) { return { @@ -556,10 +647,14 @@ function parseReflectionType(type: any, map: Map) { if (!type.declaration) return undefined let res: TypeDetails - switch (type.declaration.kindString) { - case 'Type literal': + switch ((type.declaration.kindString ?? type.declaration.variant).toLowerCase()) { + case 'type literal': res = parseTypeLiteral(type, map) break + case 'declaration': + if (type.declaration.kind === KIND_TYPE_LITERAL) { + res = parseTypeLiteral(type, map) + } default: break } @@ -590,8 +685,8 @@ function parseTypeLiteral(type: any, map: Map): TypeDetails { } } - if ('indexSignature' in type.declaration) { - const signature = type.declaration.indexSignature + if ('indexSignature' in type.declaration || 'indexSignatures' in type.declaration) { + const signature = type.declaration.indexSignature ?? type.declaration.indexSignatures[0] return { name, @@ -636,10 +731,11 @@ function parseInterface(type: any, map: Map): CustomObjectType { // properties of an interface. function parseTypeInternals(elem: any, map: Map) { - switch (elem.kindString) { - case 'Property': + switch ((elem.kindString || elem.variant).toLowerCase()) { + case 'property': + case 'declaration': return parseInternalProperty(elem, map) - case 'Method': + case 'method': if (elem.signatures?.[0]) { const { params, ret, comment } = parseSignature(elem.signatures?.[0], map) const res = { @@ -651,7 +747,7 @@ function parseTypeInternals(elem: any, map: Map) { } as CustomFunctionType if (elem.comment) { - res.comment = { ...res.comment, ...elem.comment } + res.comment = { ...normalizeComment(res.comment), ...normalizeComment(elem.comment) } } return res @@ -675,7 +771,7 @@ function parseInternalProperty(elem: any, map: Map) { } if (elem.comment) { - res.comment = elem.comment + res.comment = normalizeComment(elem.comment) } return res diff --git a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap index 74f154685a1..e5069246e0a 100644 --- a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap +++ b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap @@ -5970,6 +5970,212 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] } }, + "@supabase/auth-js.GoTrueClient.getClaims": { + "name": "@supabase/auth-js.GoTrueClient.getClaims", + "params": [ + { + "name": "jwt", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "jwks", + "type": { + "type": "object", + "properties": [ + { + "name": "keys", + "type": { + "type": "array", + "elemType": { + "type": "object", + "name": "JWK", + "properties": [ + { + "name": "alg", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "key_ops", + "type": { + "type": "array", + "elemType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "name": "kid", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "kty", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "RSA" + }, + { + "type": "literal", + "value": "EC" + }, + { + "type": "literal", + "value": "oct" + } + ] + } + } + ] + } + } + } + ] + } + } + ], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "object", + "properties": [ + { + "name": "claims", + "type": { + "type": "nameOnly", + "name": "JwtPayload" + } + }, + { + "name": "header", + "type": { + "name": "JwtHeader", + "type": "object", + "properties": [ + { + "name": "alg", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "RS256" + }, + { + "type": "literal", + "value": "ES256" + }, + { + "type": "literal", + "value": "HS256" + } + ] + } + }, + { + "name": "kid", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "typ", + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "name": "signature", + "type": { + "type": "nameOnly", + "name": "Uint8Array" + } + } + ] + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "nameOnly", + "name": "AuthError" + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + } + ] + } + } + }, + "comment": {} + }, "@supabase/auth-js.GoTrueClient.getSession": { "name": "@supabase/auth-js.GoTrueClient.getSession", "params": [], @@ -26569,6 +26775,9 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": { "type": "intrinsic", "name": "string" + }, + "comment": { + "shortText": "Topic name can be any string." } }, { @@ -26648,9 +26857,19 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, { - "name": "socket" + "name": "socket", + "type": { + "type": "nameOnly", + "name": "RealtimeClient" + } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + } }, "@supabase/realtime-js.RealtimeChannel.on": { "name": "@supabase/realtime-js.RealtimeChannel.on", @@ -26691,6 +26910,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, "comment": { "shortText": "Creates an event handler that listens to changes." }, @@ -26772,7 +26997,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } }, { "params": [ @@ -26851,7 +27085,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } }, { "params": [ @@ -26924,9 +27167,18 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "union", "name": "RealtimePostgresChangesPayload", "subTypes": [ - null, - null, - null + { + "type": "nameOnly", + "name": "RealtimePostgresInsertPayload" + }, + { + "type": "nameOnly", + "name": "RealtimePostgresUpdatePayload" + }, + { + "type": "nameOnly", + "name": "RealtimePostgresDeletePayload" + } ] } } @@ -26939,7 +27191,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } }, { "params": [ @@ -27022,7 +27283,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } }, { "params": [ @@ -27105,7 +27375,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } }, { "params": [ @@ -27188,7 +27467,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } }, { "params": [ @@ -27256,10 +27544,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Function to be invoked when event handler is triggered.\\n" + "shortText": "Function to be invoked when event handler is triggered." } } ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, "comment": { "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." } @@ -27331,7 +27625,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } }, { "params": [ @@ -27366,7 +27669,16 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, + "comment": { + "shortText": "Creates an event handler that listens to changes." + } } ] }, @@ -27463,7 +27775,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Options to be used during the send process\\n" + "shortText": "Options to be used during the send process" } } ], @@ -27536,6 +27848,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + }, "comment": { "shortText": "Subscribe registers your client with the server" } @@ -27632,8 +27950,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\\nTriggers onClose() hooks.\\n\\nTo receive leave acknowledgements, use the a \`receive\` hook to bind to the server ack, ie:\\nchannel.unsubscribe().receive(\\"ok\\", () => alert(\\"left!\\") )\\n" + "shortText": "Leaves the channel.\\n\\nUnsubscribes from server events, and instructs channel to terminate on server.\\nTriggers onClose() hooks.\\n\\nTo receive leave acknowledgements, use the a \`receive\` hook to bind to the server ack, ie:\\nchannel.unsubscribe().receive(\\"ok\\", () => alert(\\"left!\\") )" } }, "@supabase/realtime-js.RealtimeChannel.untrack": { @@ -27723,6 +28040,33 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "RealtimeClientOptions", "type": "object", "properties": [ + { + "name": "accessToken", + "type": { + "type": "function", + "params": [], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + } + } + }, + "isOptional": true + }, { "name": "decode", "type": { @@ -27773,25 +28117,8 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "log_level", "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] + "type": "nameOnly", + "name": "LogLevel" }, "isOptional": true }, @@ -27803,6 +28130,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "logLevel", + "type": { + "type": "nameOnly", + "name": "LogLevel" + }, + "isOptional": true + }, { "name": "params", "type": { @@ -27857,65 +28192,20 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "isOptional": true - }, - { - "type": "function", - "name": "accessToken", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - } } ] }, "isOptional": true } ], - "comment": { - "shortText": "Initializes the Socket." - } - }, - "@supabase/realtime-js.RealtimeClient._workerObjectUrl": { - "name": "@supabase/realtime-js.RealtimeClient._workerObjectUrl", - "params": [ - { - "name": "url", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], "ret": { "type": { - "type": "intrinsic", - "name": "string" + "type": "nameOnly", + "name": "RealtimeClient" } + }, + "comment": { + "shortText": "Initializes the Socket." } }, "@supabase/realtime-js.RealtimeClient.channel": { @@ -28004,7 +28294,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] } } - ] + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + } + } }, "@supabase/realtime-js.RealtimeClient.connect": { "name": "@supabase/realtime-js.RealtimeClient.connect", @@ -28054,7 +28350,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom reason for the disconnect.\\n" + "shortText": "A custom reason for the disconnect." } } ], @@ -28078,8 +28374,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\\n" + "shortText": "Returns the URL of the websocket." } }, "@supabase/realtime-js.RealtimeClient.flushSendBuffer": { @@ -28100,7 +28395,11 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "params": [], "ret": { "type": { - "type": "array" + "type": "array", + "elemType": { + "type": "nameOnly", + "name": "RealtimeChannel" + } } }, "comment": { @@ -28153,8 +28452,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, \`this.logger\` can be overridden.\\n" + "shortText": "Logs the message.\\n\\nFor customized logging, \`this.logger\` can be overridden." } }, "@supabase/realtime-js.RealtimeClient.push": { @@ -28213,8 +28511,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\\n" + "shortText": "Push out a message if the socket is connected.\\n\\nIf the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established." } }, "@supabase/realtime-js.RealtimeClient.removeAllChannels": { @@ -28256,8 +28553,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "params": [ { "name": "channel", + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + }, "comment": { - "shortText": "A RealtimeChannel instance\\n" + "shortText": "A RealtimeChannel instance" } } ], @@ -28325,7 +28626,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "A JWT string to override the token set on the client.\\n" + "shortText": "A JWT string to override the token set on the client." } } ], @@ -28340,8 +28641,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the \`accessToken\` callback function or the token set on the client.\\n\\nOn callback used, it will set the value of the token internal to the client.\\n" + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.\\n\\nIf param is null it will use the \`accessToken\` callback function or the token set on the client.\\n\\nOn callback used, it will set the value of the token internal to the client." } }, "@supabase/realtime-js.RealtimePresence.constructor": { @@ -28349,6 +28649,10 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "params": [ { "name": "channel", + "type": { + "type": "nameOnly", + "name": "RealtimeChannel" + }, "comment": { "shortText": "The RealtimeChannel" } @@ -28357,14 +28661,20 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "opts", "type": { "type": "nameOnly", - "name": "@types/phoenix.PresenceOpts" + "name": "PresenceOpts" }, "isOptional": true, "comment": { - "shortText": "The options,\\n for example \`{events: {state: 'state', diff: 'diff'}}\`\\n" + "shortText": "The options,\\n for example \`{events: {state: 'state', diff: 'diff'}}\`" } } ], + "ret": { + "type": { + "type": "nameOnly", + "name": "RealtimePresence" + } + }, "comment": { "shortText": "Initializes the Presence." } diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json index ff478c31d68..0872d2b5f15 100644 --- a/apps/docs/spec/api_v1_openapi.json +++ b/apps/docs/spec/api_v1_openapi.json @@ -1651,6 +1651,128 @@ "security": [{ "bearer": [] }] } }, + "/v1/projects/{ref}/config/auth/signing-keys": { + "post": { + "operationId": "createSigningKeyForProject", + "summary": "[Alpha] Create a new signing key for the project in standby status", + "parameters": [ + { "name": "ref", "required": true, "in": "path", "schema": { "type": "string" } } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/CreateSigningKeyBody" } + } + } + }, + "responses": { + "201": { + "description": "[Alpha] Create a new signing key for the project in standby status", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/CreateSigningKeyBody" } + } + } + }, + "403": { "description": "" } + }, + "tags": ["Auth"], + "security": [{ "bearer": [] }] + }, + "get": { + "operationId": "listSigningKeysForProject", + "summary": "[Alpha] List all signing keys for the project", + "parameters": [ + { "name": "ref", "required": true, "in": "path", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SigningKeysResponse" } + } + } + }, + "403": { "description": "" } + }, + "tags": ["Auth"], + "security": [{ "bearer": [] }] + } + }, + "/v1/projects/{ref}/config/auth/signing-keys/{id}": { + "get": { + "operationId": "getSigningKeyForProject", + "summary": "[Alpha] Get information about a signing key", + "parameters": [ + { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, + { "name": "ref", "required": true, "in": "path", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SigningKeyResponse" } + } + } + } + }, + "tags": ["Auth"], + "security": [{ "bearer": [] }] + }, + "delete": { + "operationId": "deleteSigningKey", + "summary": "[Alpha] Remove a signing key from a project, where the status is previously_used", + "parameters": [ + { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, + { "name": "ref", "required": true, "in": "path", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SigningKeyResponse" } + } + } + }, + "403": { "description": "" } + }, + "tags": ["Auth"], + "security": [{ "bearer": [] }] + }, + "patch": { + "operationId": "patchSigningKey", + "summary": "[Alpha] Update a signing key, mainly its status", + "parameters": [ + { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, + { "name": "ref", "required": true, "in": "path", "schema": { "type": "string" } } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/UpdateSigningKeyBody" } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SigningKeyResponse" } + } + } + }, + "403": { "description": "" } + }, + "tags": ["Auth"], + "security": [{ "bearer": [] }] + } + }, "/v1/projects/{ref}/config/storage": { "get": { "operationId": "v1-get-storage-config", @@ -3810,6 +3932,68 @@ }, "required": ["name", "healthy", "status"] }, + "CreateSigningKeyBody": { + "type": "object", + "properties": { + "algorithm": { "type": "string", "enum": ["EdDSA", "ES256", "RS256", "HS256"] }, + "status": { "type": "string", "enum": ["in_use", "standby"] } + }, + "required": ["algorithm"], + "additionalProperties": false + }, + "SigningKeysResponse": { + "type": "object", + "properties": { + "keys": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "uuid" }, + "algorithm": { "type": "string", "enum": ["EdDSA", "ES256", "RS256", "HS256"] }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { "nullable": true }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + } + } + }, + "required": ["keys"], + "additionalProperties": false + }, + "SigningKeyResponse": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "uuid" }, + "algorithm": { "type": "string", "enum": ["EdDSA", "ES256", "RS256", "HS256"] }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { "nullable": true }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + }, + "UpdateSigningKeyBody": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + } + }, + "required": ["status"], + "additionalProperties": false + }, "StorageFeatureImageTransformation": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, diff --git a/apps/docs/spec/enrichments/tsdoc_v2/combined.json b/apps/docs/spec/enrichments/tsdoc_v2/combined.json index 3b14109903f..71665f0c469 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/combined.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/combined.json @@ -63779,8797 +63779,633 @@ { "id": 0, "name": "@supabase/realtime-js", + "variant": "project", "kind": 1, - "kindString": "Project", "flags": {}, - "originalName": "", "children": [ { - "id": 614, + "id": 618, "name": "REALTIME_LISTEN_TYPES", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 615, + "id": 619, "name": "BROADCAST", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 98, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L98" } ], "type": { "type": "literal", "value": "broadcast" - }, - "defaultValue": "\"broadcast\"" + } }, { - "id": 617, + "id": 621, "name": "POSTGRES_CHANGES", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 100, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L100" } ], "type": { "type": "literal", "value": "postgres_changes" - }, - "defaultValue": "\"postgres_changes\"" + } }, { - "id": 616, + "id": 620, "name": "PRESENCE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L99" } ], "type": { "type": "literal", "value": "presence" - }, - "defaultValue": "\"presence\"" + } }, { - "id": 618, + "id": 622, "name": "SYSTEM", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L101" } ], "type": { "type": "literal", "value": "system" - }, - "defaultValue": "\"system\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [615, 617, 616, 618] + "children": [619, 621, 620, 622] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 97, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L97" } ] }, { - "id": 619, + "id": 623, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 620, + "id": 624, "name": "ALL", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L91" } ], "type": { "type": "literal", "value": "*" - }, - "defaultValue": "\"*\"" + } }, { - "id": 623, + "id": 627, "name": "DELETE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L94" } ], "type": { "type": "literal", "value": "DELETE" - }, - "defaultValue": "\"DELETE\"" + } }, { - "id": 621, + "id": 625, "name": "INSERT", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 92, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L92" } ], "type": { "type": "literal", "value": "INSERT" - }, - "defaultValue": "\"INSERT\"" + } }, { - "id": 622, + "id": 626, "name": "UPDATE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 93, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L93" } ], "type": { "type": "literal", "value": "UPDATE" - }, - "defaultValue": "\"UPDATE\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [620, 623, 621, 622] + "children": [624, 627, 625, 626] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 90, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L90" } ] }, { - "id": 624, + "id": 628, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 626, + "id": 630, "name": "JOIN", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L37" } ], "type": { "type": "literal", "value": "join" - }, - "defaultValue": "\"join\"" + } }, { - "id": 627, + "id": 631, "name": "LEAVE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L38" } ], "type": { "type": "literal", "value": "leave" - }, - "defaultValue": "\"leave\"" + } }, { - "id": 625, + "id": 629, "name": "SYNC", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L36" } ], "type": { "type": "literal", "value": "sync" - }, - "defaultValue": "\"sync\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [626, 627, 625] + "children": [630, 631, 629] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 35, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L35" } ] }, { - "id": 628, + "id": 632, "name": "REALTIME_SUBSCRIBE_STATES", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 632, + "id": 636, "name": "CHANNEL_ERROR", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 108, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L108" } ], "type": { "type": "literal", "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" + } }, { - "id": 631, + "id": 635, "name": "CLOSED", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 107, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L107" } ], "type": { "type": "literal", "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" + } }, { - "id": 629, + "id": 633, "name": "SUBSCRIBED", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 105, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L105" } ], "type": { "type": "literal", "value": "SUBSCRIBED" - }, - "defaultValue": "\"SUBSCRIBED\"" + } }, { - "id": 630, + "id": 634, "name": "TIMED_OUT", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 106, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L106" } ], "type": { "type": "literal", "value": "TIMED_OUT" - }, - "defaultValue": "\"TIMED_OUT\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [632, 631, 629, 630] + "children": [636, 635, 633, 634] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 104, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L104" } ] }, { - "id": 64, + "id": 65, "name": "RealtimeChannel", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + "summary": [ + { + "kind": "text", + "text": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + } + ] }, "children": [ { - "id": 75, + "id": 76, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 147, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L147" } ], "signatures": [ { - "id": 76, - "name": "new RealtimeChannel", + "id": 77, + "name": "RealtimeChannel", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 147, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L147" + } + ], "parameters": [ { - "id": 77, + "id": 78, "name": "topic", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 78, + "id": 79, "name": "params", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 358, + "target": 359, "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } + "package": "@supabase/realtime-js" }, "defaultValue": "..." }, { - "id": 79, + "id": 80, "name": "socket", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, - 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, - 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, - 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, - 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 80, + "id": 81, "name": "bindings", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 128, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L128" } ], "type": { "type": "reflection", "declaration": { - "id": 81, + "id": 82, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 + "line": 128, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L128" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "indexSignatures": [ + { + "id": 83, + "name": "__index", + "variant": "signature", + "kind": 8192, "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 36, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 84, - "character": 2 + "line": 129, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L129" } ], - "signatures": [ + "parameters": [ { - "id": 37, - "name": "new RealtimePresence", - "kind": 16384, - "kindString": "Constructor signature", + "id": 84, + "name": "key", + "variant": "param", + "kind": 32768, "flags": {}, - "comment": { - "shortText": "Initializes the Presence." - }, - "parameters": [ - { - "id": 38, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The RealtimeChannel" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - }, - { - "id": 39, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" - }, - "type": { - "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" - } - } - ], "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 44, - "name": "caller", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 45, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 46, - "name": "onJoin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 68, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" - } - }, - { - "id": 47, - "name": "onLeave", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 69, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" - } - }, - { - "id": 48, - "name": "onSync", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 70, - "character": 4 - } - ], - "signatures": [ - { - "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, - { - "title": "Methods", - "kind": 2048, - "children": [48] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 50, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - }, - { - "id": 43, - "name": "joinRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { "type": "intrinsic", "name": "string" } - ] - }, - "defaultValue": "null" - }, - { - "id": 42, - "name": "pendingDiffs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 65, - "character": 2 } ], "type": { "type": "array", "elementType": { - "type": "reference", - "name": "RawPresenceDiff" - } - }, - "defaultValue": "[]" - }, - { - "id": 40, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 41, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ], - "name": "RealtimePresenceState", - "dereferenced": { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", + "type": "reflection", + "declaration": { + "id": 85, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 91, + "name": "callback", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 132, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L132" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 87, + "name": "filter", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 88, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "parameters": [ + "sources": [ { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" } ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 605, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 75 - } - ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ + "indexSignatures": [ { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } - } - } - } - } - } - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, - 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, - 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, + "id": 89, "name": "__index", + "variant": "signature", "kind": 8192, - "kindString": "Index signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" + } + ], "parameters": [ { - "id": 228, + "id": 90, "name": "key", + "variant": "param", "kind": 32768, "flags": {}, "type": { @@ -72583,7 +64419,794 @@ "name": "any" } } - } + ] + } + } + }, + { + "id": 92, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 133, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L133" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 86, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L130" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [91, 87, 92, 86] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 129, + "character": 19, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L129" + } + ] + } + } + } + } + ] + } + }, + "defaultValue": "{}" + }, + { + "id": 100, + "name": "broadcastEndpointURL", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 143, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L143" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 95, + "name": "joinedOnce", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 138, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L138" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 96, + "name": "joinPush", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 139, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L139" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 104, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 150, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L150" + } + ], + "type": { + "type": "reference", + "target": 359, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" + }, + "defaultValue": "..." + }, + { + "id": 99, + "name": "presence", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 142, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L142" + } + ], + "type": { + "type": "reference", + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 102, + "name": "private", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L145" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 98, + "name": "pushBuffer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 141, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L141" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + "defaultValue": "[]" + }, + { + "id": 97, + "name": "rejoinTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 140, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L140" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 105, + "name": "socket", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 151, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L151" + } + ], + "type": { + "type": "reference", + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 94, + "name": "state", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 137, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L137" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CHANNEL_STATES" + }, + "name": "CHANNEL_STATES", + "package": "@supabase/realtime-js" + }, + "defaultValue": "CHANNEL_STATES.closed" + }, + { + "id": 101, + "name": "subTopic", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L144" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 93, + "name": "timeout", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 136, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L136" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 103, + "name": "topic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 149, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L149" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 137, + "name": "on", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 350, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L350" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 391, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L391" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 414, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L414" + } + ], + "signatures": [ + { + "id": 138, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 350, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L350" + } + ], + "parameters": [ + { + "id": 139, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 140, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 141, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 142, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 352, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L352" + } + ], + "type": { + "type": "literal", + "value": "sync" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [142] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 352, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L352" + } + ] + } + } + }, + { + "id": 143, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 144, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 353, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L353" + } + ], + "signatures": [ + { + "id": 145, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 353, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L353" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 146, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "typeParameters": [ + { + "id": 147, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 148, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "indexSignatures": [ + { + "id": 149, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "parameters": [ + { + "id": 150, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 151, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 152, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 153, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 154, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 357, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L357" + } + ], + "type": { + "type": "literal", + "value": "join" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [154] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 357, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L357" + } + ] + } + } + }, + { + "id": 155, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 156, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 358, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L358" + } + ], + "signatures": [ + { + "id": 157, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 358, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L358" + } + ], + "parameters": [ + { + "id": 158, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 588, + "typeArguments": [ + { + "type": "reference", + "target": 147, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceJoinPayload", + "package": "@supabase/realtime-js" } } ], @@ -72599,96 +65222,1087 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 229, + "id": 159, "name": "on", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ { - "id": 233, + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + } + ], + "typeParameters": [ + { + "id": 160, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 230, + "id": 161, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" } - } + ], + "indexSignatures": [ + { + "id": 162, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + } + ], + "parameters": [ + { + "id": 163, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } ], "parameters": [ { - "id": 234, + "id": 164, "name": "type", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 165, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 167, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 362, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L362" + } + ], + "type": { + "type": "literal", + "value": "leave" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [167] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 362, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L362" + } + ] + } + } + }, + { + "id": 168, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 169, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 363, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L363" + } + ], + "signatures": [ + { + "id": 170, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 363, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L363" + } + ], + "parameters": [ + { + "id": 171, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 598, + "typeArguments": [ + { + "type": "reference", + "target": 160, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceLeavePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 172, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "typeParameters": [ + { + "id": 173, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 174, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "indexSignatures": [ + { + "id": 175, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "parameters": [ + { + "id": 176, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 177, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 178, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "*" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 179, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 368, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L368" + } + ], + "signatures": [ + { + "id": 181, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 368, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L368" + } + ], + "parameters": [ + { + "id": 182, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 554, + "typeArguments": [ + { + "type": "reference", + "target": 173, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresChangesPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 183, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "typeParameters": [ + { + "id": 184, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 185, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "indexSignatures": [ + { + "id": 186, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "parameters": [ + { + "id": 187, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 188, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 189, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "INSERT" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 190, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 191, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L373" + } + ], + "signatures": [ + { + "id": 192, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L373" + } + ], + "parameters": [ + { + "id": 193, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 559, + "typeArguments": [ + { + "type": "reference", + "target": 184, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresInsertPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 194, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "typeParameters": [ + { + "id": 195, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 196, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "indexSignatures": [ + { + "id": 197, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "parameters": [ + { + "id": 198, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 199, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 200, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "UPDATE" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 201, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 202, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L378" + } + ], + "signatures": [ + { + "id": 203, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L378" + } + ], + "parameters": [ + { + "id": 204, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 569, + "typeArguments": [ + { + "type": "reference", + "target": 195, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresUpdatePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 205, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "typeParameters": [ + { + "id": 206, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 207, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "indexSignatures": [ + { + "id": 208, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "parameters": [ + { + "id": 209, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 210, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 211, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "DELETE" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 212, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 213, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L383" + } + ], + "signatures": [ + { + "id": 214, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L383" + } + ], + "parameters": [ + { + "id": 215, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 578, + "typeArguments": [ + { + "type": "reference", + "target": 206, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresDeletePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 216, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 391, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L391" + } + ], + "parameters": [ + { + "id": 217, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." + } + ] + }, "type": { "type": "literal", "value": "broadcast" } }, { - "id": 235, + "id": 218, "name": "filter", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom object specific to the Realtime feature detailing which payloads to receive." + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 236, + "id": 219, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 237, + "id": 220, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 + "line": 393, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L393" } ], "type": { @@ -72700,61 +66314,93 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [237] + "children": [220] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 393, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L393" } ] } } }, { - "id": 238, + "id": 221, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Function to be invoked when event handler is triggered." + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 239, + "id": 222, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], "signatures": [ { - "id": 240, + "id": 223, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], "parameters": [ { - "id": 241, + "id": 224, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 242, + "id": 225, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 244, + "id": 227, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 + "line": 396, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L396" } ], "type": { @@ -72763,35 +66409,17 @@ } }, { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, + "id": 226, "name": "type", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 + "line": 395, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L395" } ], "type": { @@ -72803,8 +66431,49 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] + "children": [227, 226] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], + "indexSignatures": [ + { + "id": 228, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 397, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L397" + } + ], + "parameters": [ + { + "id": 229, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } } ] } @@ -72823,64 +66492,398 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 246, + "id": 230, "name": "on", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ { - "id": 250, + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + } + ], + "typeParameters": [ + { + "id": 231, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 247, + "id": 232, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" } - } + ], + "indexSignatures": [ + { + "id": 233, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + } + ], + "parameters": [ + { + "id": 234, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } ], "parameters": [ { - "id": 251, + "id": 235, "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "broadcast" + } + }, + { + "id": 236, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 238, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 402, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L402" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [238] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 402, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L402" + } + ] + } + } + }, + { + "id": 239, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 240, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ], + "signatures": [ + { + "id": 241, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ], + "parameters": [ + { + "id": 242, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 243, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 245, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 405, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L405" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 246, + "name": "payload", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 406, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L406" + } + ], + "type": { + "type": "reference", + "target": 231, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + }, + { + "id": 244, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 404, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L404" + } + ], + "type": { + "type": "literal", + "value": "broadcast" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [245, 246, 244] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 247, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "typeParameters": [ + { + "id": 248, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 249, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "indexSignatures": [ + { + "id": 250, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "parameters": [ + { + "id": 251, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 252, + "name": "type", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "literal", @@ -72888,49 +66891,65 @@ } }, { - "id": 252, + "id": 253, "name": "filter", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 253, + "id": 254, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } }, { - "id": 254, + "id": 255, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 256, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 412, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L412" + } + ], "signatures": [ { - "id": 256, + "id": 257, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 412, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L412" + } + ], "parameters": [ { - "id": 257, + "id": 258, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -72950,79 +66969,109 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 113, + "id": 114, "name": "presenceState", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 315, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L315" } ], "signatures": [ { - "id": 114, + "id": 115, "name": "presenceState", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "sources": [ { - "id": 119, + "fileName": "src/RealtimeChannel.ts", + "line": 315, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L315" + } + ], + "typeParameters": [ + { + "id": 116, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 115, + "id": 117, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 316, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L316" } - } + ], + "indexSignatures": [ + { + "id": 118, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 316, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L316" + } + ], + "parameters": [ + { + "id": 119, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "default": { "type": "reflection", "declaration": { - "id": 118, + "id": 120, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } @@ -73030,75 +67079,103 @@ ], "type": { "type": "reference", - "id": 604, + "target": 608, "typeArguments": [ { "type": "reference", - "id": 119, - "name": "T" + "target": 116, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "name": "RealtimePresenceState" + "name": "RealtimePresenceState", + "package": "@supabase/realtime-js" } } ] }, { - "id": 258, + "id": 259, "name": "send", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 430, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L430" } ], "signatures": [ { - "id": 259, + "id": 260, "name": "send", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a message into the channel." + "summary": [ + { + "kind": "text", + "text": "Sends a message into the channel." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 430, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L430" + } + ], "parameters": [ { - "id": 260, + "id": 261, "name": "args", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Arguments to send to channel" + "summary": [ + { + "kind": "text", + "text": "Arguments to send to channel" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 262, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 263, + "id": 264, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The name of the event being sent" + "summary": [ + { + "kind": "text", + "text": "The name of the event being sent" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 433, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L433" } ], "type": { @@ -73107,21 +67184,27 @@ } }, { - "id": 264, + "id": 265, "name": "payload", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Payload to be sent" + "summary": [ + { + "kind": "text", + "text": "Payload to be sent" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 434, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L434" } ], "type": { @@ -73130,19 +67213,25 @@ } }, { - "id": 262, + "id": 263, "name": "type", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of event to send" + "summary": [ + { + "kind": "text", + "text": "The type of event to send" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 432, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L432" } ], "type": { @@ -73167,76 +67256,118 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] + "children": [264, 265, 263] } ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 431, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L431" } - } + ], + "indexSignatures": [ + { + "id": 266, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 435, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L435" + } + ], + "parameters": [ + { + "id": 267, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } }, { - "id": 267, + "id": 268, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Options to be used during the send process\n" + "summary": [ + { + "kind": "text", + "text": "Options to be used during the send process" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 269, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 437, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L437" } - } + ], + "indexSignatures": [ + { + "id": 270, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 437, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L437" + } + ], + "parameters": [ + { + "id": 271, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -73244,93 +67375,131 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 105, + "id": 106, "name": "subscribe", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 213, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L213" } ], "signatures": [ { - "id": 106, + "id": 107, "name": "subscribe", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Subscribe registers your client with the server" + "summary": [ + { + "kind": "text", + "text": "Subscribe registers your client with the server" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 213, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L213" + } + ], "parameters": [ { - "id": 107, + "id": 108, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 109, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 214, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L214" + } + ], "signatures": [ { - "id": 109, + "id": 110, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 214, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L214" + } + ], "parameters": [ { - "id": 110, + "id": 111, "name": "status", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" + "target": 632, + "name": "REALTIME_SUBSCRIBE_STATES", + "package": "@supabase/realtime-js" } }, { - "id": 111, + "id": 112, "name": "err", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" } } ], @@ -73344,10 +67513,10 @@ } }, { - "id": 112, + "id": 113, "name": "timeout", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -73358,110 +67527,159 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 120, + "id": 121, "name": "track", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 321, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L321" } ], "signatures": [ { - "id": 121, + "id": 122, "name": "track", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 321, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L321" + } + ], "parameters": [ { - "id": 122, + "id": 123, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 123, + "id": 124, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 322, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L322" } - } + ], + "indexSignatures": [ + { + "id": 125, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 322, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L322" + } + ], + "parameters": [ + { + "id": 126, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } }, { - "id": 126, + "id": 127, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 127, + "id": 128, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 323, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L323" } - } + ], + "indexSignatures": [ + { + "id": 129, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 323, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L323" + } + ], + "parameters": [ + { + "id": 130, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -73469,50 +67687,75 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 277, + "id": 278, "name": "unsubscribe", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 507, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L507" } ], "signatures": [ { - "id": 278, + "id": 279, "name": "unsubscribe", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" + "summary": [ + { + "kind": "text", + "text": "Leaves the channel.\n\nUnsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a " + }, + { + "kind": "code", + "text": "`receive`" + }, + { + "kind": "text", + "text": " hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 507, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L507" + } + ], "parameters": [ { - "id": 279, + "id": 280, "name": "timeout", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -73523,6 +67766,10 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "union", @@ -73542,71 +67789,98 @@ ] } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 130, + "id": 131, "name": "untrack", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 335, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L335" } ], "signatures": [ { - "id": 131, + "id": 132, "name": "untrack", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 335, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L335" + } + ], "parameters": [ { - "id": 132, + "id": 133, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 133, + "id": 134, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 336, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L336" } - } + ], + "indexSignatures": [ + { + "id": 135, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 336, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L336" + } + ], + "parameters": [ + { + "id": 136, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -73614,78 +67888,110 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 271, + "id": 272, "name": "updateJoinPayload", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 494, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" } ], "signatures": [ { - "id": 272, + "id": 273, "name": "updateJoinPayload", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" + } + ], "parameters": [ { - "id": 273, + "id": 274, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 275, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 29, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" } - } + ], + "indexSignatures": [ + { + "id": 276, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 31, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" + } + ], + "parameters": [ + { + "id": 277, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } @@ -73701,67 +68007,84 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [75] + "children": [76] }, { "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] + "children": [81, 100, 95, 96, 104, 99, 102, 98, 97, 105, 94, 101, 93, 103] }, { "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] + "children": [137, 114, 259, 106, 121, 278, 131, 272] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 127, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L127" } ] }, { - "id": 371, + "id": 372, "name": "RealtimeClient", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "children": [ { - "id": 372, + "id": 373, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L144" } ], "signatures": [ { - "id": 373, - "name": "new RealtimeClient", + "id": 374, + "name": "RealtimeClient", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Initializes the Socket." + "summary": [ + { + "kind": "text", + "text": "Initializes the Socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L144" + } + ], "parameters": [ { - "id": 374, + "id": 375, "name": "endPoint", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + "summary": [ + { + "kind": "text", + "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + } + ] }, "type": { "type": "intrinsic", @@ -73769,489 +68092,125 @@ } }, { - "id": 375, + "id": 376, "name": "options", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "id": 513, + "target": 515, "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ + "package": "@supabase/realtime-js", + "highlightedProperties": { + "transport": [ { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 + "kind": "text", + "text": "The Websocket Transport, for example WebSocket. This can be a custom implementation" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] + "timeout": [ + { + "kind": "text", + "text": "The default timeout in milliseconds to trigger push timeouts." } - } + ], + "params": [ + { + "kind": "text", + "text": "The optional params to pass when connecting." + } + ], + "headers": [ + { + "kind": "text", + "text": "The optional headers to pass when connecting." + } + ], + "heartbeatIntervalMs": [ + { + "kind": "text", + "text": "The millisec interval to send a heartbeat message." + } + ], + "logger": [ + { + "kind": "text", + "text": "The optional function for specialized logging, ie: logger: (kind, msg, data) => { console.log(" + }, + { + "kind": "code", + "text": "`${kind}: ${msg}`" + }, + { + "kind": "text", + "text": ", data) }" + } + ], + "logLevel": [ + { + "kind": "text", + "text": "Sets the log level for Realtime" + } + ], + "encode": [ + { + "kind": "text", + "text": "The function to encode outgoing messages. Defaults to JSON: (payload, callback) => callback(JSON.stringify(payload))" + } + ], + "decode": [ + { + "kind": "text", + "text": "The function to decode incoming messages. Defaults to Serializer's decode." + } + ], + "reconnectAfterMs": [ + { + "kind": "text", + "text": "he optional function that returns the millsec reconnect interval. Defaults to stepped backoff off." + } + ], + "worker": [ + { + "kind": "text", + "text": "Use Web Worker to set a side flow. Defaults to false." + } + ], + "workerUrl": [ + { + "kind": "text", + "text": "The URL of the worker script. Defaults to https://realtime.supabase.com/worker.js that includes a heartbeat event call to keep the connection alive." + } + ] } } } ], "type": { "type": "reference", - "id": 371, - "name": "default" + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 417, + "id": 419, "name": "accessToken", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" } ], "type": { @@ -74264,20 +68223,40 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 420, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" + } + ], "signatures": [ { - "id": 419, + "id": 421, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "union", @@ -74293,9 +68272,8 @@ ] } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -74305,45 +68283,18 @@ }, "defaultValue": "null" }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, { "id": 377, - "name": "apiKey", + "name": "accessTokenValue", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 + "line": 87, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L87" } ], "type": { @@ -74363,38 +68314,71 @@ }, { "id": 378, - "name": "channels", + "name": "apiKey", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 + "line": 88, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L88" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 379, + "name": "channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 89, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L89" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, "defaultValue": "[]" }, { - "id": 400, + "id": 402, "name": "conn", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 + "line": 106, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L106" } ], "type": { @@ -74406,63 +68390,77 @@ }, { "type": "reference", - "name": "WebSocketLike" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLike" + }, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" } ] }, "defaultValue": "null" }, { - "id": 398, + "id": 400, "name": "decode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 + "line": 104, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L104" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 397, + "id": 399, "name": "encode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 + "line": 103, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L103" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 379, + "id": 380, "name": "endPoint", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 + "line": 90, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L90" } ], "type": { @@ -74472,101 +68470,159 @@ "defaultValue": "''" }, { - "id": 409, + "id": 411, "name": "fetch", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 + "line": 120, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L120" } ], "type": { "type": "reflection", "declaration": { - "id": 410, + "id": 412, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 28708, + "character": 17 + }, + { + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], "signatures": [ { - "id": 411, + "id": 413, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 28708, + "character": 17 + } + ], "parameters": [ { - "id": 412, + "id": 414, "name": "input", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInfo" + }, + "name": "RequestInfo", + "package": "typescript" }, { "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } ] } }, { - "id": 413, + "id": 415, "name": "init", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } }, { - "id": 414, + "id": 416, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], "parameters": [ { - "id": 415, + "id": 417, "name": "input", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "union", @@ -74577,48 +68633,63 @@ }, { "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Request" + }, + "name": "Request", + "package": "typescript" }, { "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } ] } }, { - "id": 416, + "id": 418, "name": "init", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -74626,85 +68697,107 @@ } }, { - "id": 381, + "id": 382, "name": "headers", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 + "line": 92, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" } ], "type": { "type": "reflection", "declaration": { - "id": 382, + "id": 383, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 92, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" } - } + ], + "indexSignatures": [ + { + "id": 384, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 92, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" + } + ], + "parameters": [ + { + "id": 385, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } }, "defaultValue": "DEFAULT_HEADERS" }, { - "id": 391, + "id": 392, "name": "heartbeatIntervalMs", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L96" } ], "type": { "type": "intrinsic", "name": "number" }, - "defaultValue": "30000" + "defaultValue": "25000" }, { - "id": 392, + "id": 393, "name": "heartbeatTimer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 + "line": 97, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L97" } ], "type": { @@ -74716,25 +68809,30 @@ }, { "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", + "target": { + "sourceFileName": "node_modules/@types/node/timers.d.ts", + "qualifiedName": "__global.NodeJS.Timeout" + }, + "name": "Timeout", "package": "@types/node", - "name": "Timeout" + "qualifiedName": "__global.NodeJS.Timeout" } ] }, "defaultValue": "undefined" }, { - "id": 380, + "id": 381, "name": "httpEndpoint", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 + "line": 91, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L91" } ], "type": { @@ -74744,87 +68842,138 @@ "defaultValue": "''" }, { - "id": 396, + "id": 397, "name": "logger", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 + "line": 101, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L101" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" }, "defaultValue": "noop" }, { - "id": 385, - "name": "params", + "id": 398, + "name": "logLevel", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 + "line": 102, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L102" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "LOG_LEVEL" + }, + "name": "LOG_LEVEL", + "package": "@supabase/realtime-js" + } + }, + { + "id": 386, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" } ], "type": { "type": "reflection", "declaration": { - "id": 386, + "id": 387, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" } - } + ], + "indexSignatures": [ + { + "id": 388, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" + } + ], + "parameters": [ + { + "id": 389, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } }, "defaultValue": "{}" }, { - "id": 393, + "id": 394, "name": "pendingHeartbeatRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 + "line": 98, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L98" } ], "type": { @@ -74843,54 +68992,66 @@ "defaultValue": "null" }, { - "id": 399, + "id": 401, "name": "reconnectAfterMs", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L105" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 396, + "name": "reconnectTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 100, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L100" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 395, + "name": "ref", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L99" } ], "type": { @@ -74900,159 +69061,187 @@ "defaultValue": "0" }, { - "id": 401, + "id": 403, "name": "sendBuffer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 + "line": 107, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L107" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, "defaultValue": "[]" }, { - "id": 402, + "id": 404, "name": "serializer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 + "line": 108, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L108" } ], "type": { "type": "reference", - "name": "default" + "target": { + "sourceFileName": "src/lib/serializer.ts", + "qualifiedName": "default" + }, + "name": "Serializer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" }, "defaultValue": "..." }, { - "id": 403, + "id": 405, "name": "stateChangeCallbacks", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 + "line": 109, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L109" } ], "type": { "type": "reflection", "declaration": { - "id": 404, + "id": 406, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 406, + "id": 408, "name": "close", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 + "line": 111, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L111" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + } + }, + { + "id": 409, + "name": "error", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 112, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L112" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + } + }, + { + "id": 410, + "name": "message", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 113, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L113" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } }, { "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, "name": "open", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 + "line": 110, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L110" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } } @@ -75060,8 +69249,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] + "children": [408, 409, 410, 407] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 109, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L109" } ] } @@ -75069,16 +69265,17 @@ "defaultValue": "..." }, { - "id": 389, + "id": 390, "name": "timeout", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 + "line": 94, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L94" } ], "type": { @@ -75088,16 +69285,17 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 390, + "id": 391, "name": "transport", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 + "line": 95, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L95" } ], "type": { @@ -75109,24 +69307,30 @@ }, { "type": "reference", - "name": "WebSocketLikeConstructor" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "name": "WebSocketLikeConstructor", + "package": "@supabase/realtime-js" } ] } }, { - "id": 420, + "id": 422, "name": "worker", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 + "line": 122, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L122" } ], "type": { @@ -75135,40 +69339,45 @@ } }, { - "id": 422, + "id": 424, "name": "workerRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 + "line": 124, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L124" } ], "type": { "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Worker" + }, + "name": "Worker", + "package": "typescript" } }, { - "id": 421, + "id": 423, "name": "workerUrl", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 + "line": 123, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L123" } ], "type": { @@ -75177,82 +69386,40 @@ } }, { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, + "id": 449, "name": "channel", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L331" } ], "signatures": [ { - "id": 448, + "id": 450, "name": "channel", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L331" + } + ], "parameters": [ { - "id": 449, + "id": 451, "name": "topic", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -75260,303 +69427,67 @@ } }, { - "id": 450, + "id": 452, "name": "params", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 358, + "target": 359, "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } + "package": "@supabase/realtime-js" }, "defaultValue": "..." } ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 423, + "id": 425, "name": "connect", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 + "line": 202, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L202" } ], "signatures": [ { - "id": 424, + "id": 426, "name": "connect", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Connects the socket, unless already connected." + "summary": [ + { + "kind": "text", + "text": "Connects the socket, unless already connected." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 202, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L202" + } + ], "type": { "type": "intrinsic", "name": "void" @@ -75565,69 +69496,107 @@ ] }, { - "id": 443, + "id": 445, "name": "connectionState", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 + "line": 311, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L311" } ], "signatures": [ { - "id": 444, + "id": 446, "name": "connectionState", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the current state of the socket." + "summary": [ + { + "kind": "text", + "text": "Returns the current state of the socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 311, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L311" + } + ], "type": { "type": "reference", - "name": "CONNECTION_STATE" + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CONNECTION_STATE" + }, + "name": "CONNECTION_STATE", + "package": "@supabase/realtime-js" } } ] }, { - "id": 427, + "id": 429, "name": "disconnect", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 + "line": 252, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L252" } ], "signatures": [ { - "id": 428, + "id": 430, "name": "disconnect", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Disconnects the socket." + "summary": [ + { + "kind": "text", + "text": "Disconnects the socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 252, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L252" + } + ], "parameters": [ { - "id": 429, + "id": 431, "name": "code", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "A numeric status code to send on disconnect." + "summary": [ + { + "kind": "text", + "text": "A numeric status code to send on disconnect." + } + ] }, "type": { "type": "intrinsic", @@ -75635,15 +69604,20 @@ } }, { - "id": 430, + "id": 432, "name": "reason", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "A custom reason for the disconnect.\n" + "summary": [ + { + "kind": "text", + "text": "A custom reason for the disconnect." + } + ] }, "type": { "type": "intrinsic", @@ -75659,29 +69633,53 @@ ] }, { - "id": 425, + "id": 427, "name": "endpointURL", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 + "line": 239, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L239" } ], "signatures": [ { - "id": 426, + "id": 428, "name": "endpointURL", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" + "summary": [ + { + "kind": "text", + "text": "Returns the URL of the websocket." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "string The URL of the websocket." + } + ] + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 239, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L239" + } + ], "type": { "type": "intrinsic", "name": "string" @@ -75690,28 +69688,42 @@ ] }, { - "id": 459, + "id": 461, "name": "flushSendBuffer", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 + "line": 421, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L421" } ], "signatures": [ { - "id": 460, + "id": 462, "name": "flushSendBuffer", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Flushes send buffer" + "summary": [ + { + "kind": "text", + "text": "Flushes send buffer" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 421, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L421" + } + ], "type": { "type": "intrinsic", "name": "void" @@ -75720,62 +69732,100 @@ ] }, { - "id": 431, + "id": 433, "name": "getChannels", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 + "line": 270, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L270" } ], "signatures": [ { - "id": 432, + "id": 434, "name": "getChannels", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns all created channels" + "summary": [ + { + "kind": "text", + "text": "Returns all created channels" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 270, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L270" + } + ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } } ] }, { - "id": 445, + "id": 447, "name": "isConnected", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 + "line": 327, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L327" } ], "signatures": [ { - "id": 446, + "id": 448, "name": "isConnected", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns `true` is the connection is open." + "summary": [ + { + "kind": "text", + "text": "Returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " is the connection is open." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 327, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L327" + } + ], "type": { "type": "intrinsic", "name": "boolean" @@ -75784,57 +69834,78 @@ ] }, { - "id": 438, + "id": 440, "name": "log", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 + "line": 304, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L304" } ], "signatures": [ { - "id": 439, + "id": 441, "name": "log", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" + "summary": [ + { + "kind": "text", + "text": "Logs the message.\n\nFor customized logging, " + }, + { + "kind": "code", + "text": "`this.logger`" + }, + { + "kind": "text", + "text": " can be overridden." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 304, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L304" + } + ], "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 442, + "name": "kind", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "msg", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 444, "name": "data", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, @@ -75852,172 +69923,54 @@ ] }, { - "id": 451, + "id": 453, "name": "push", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 + "line": 345, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L345" } ], "signatures": [ { - "id": 452, + "id": 454, "name": "push", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" + "summary": [ + { + "kind": "text", + "text": "Push out a message if the socket is connected.\n\nIf the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 345, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L345" + } + ], "parameters": [ { - "id": 453, + "id": 455, "name": "data", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 536, + "target": 540, "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } + "package": "@supabase/realtime-js" } } ], @@ -76029,4592 +69982,260 @@ ] }, { - "id": 436, + "id": 438, "name": "removeAllChannels", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 + "line": 291, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L291" } ], "signatures": [ { - "id": 437, + "id": 439, "name": "removeAllChannels", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes all channels" + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes all channels" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 291, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L291" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" + "target": 617, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" } } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 433, + "id": 435, "name": "removeChannel", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 + "line": 278, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L278" } ], "signatures": [ { - "id": 434, + "id": 436, "name": "removeChannel", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes a single channel" + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes a single channel" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 278, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L278" + } + ], "parameters": [ { - "id": 435, + "id": 437, "name": "channel", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A RealtimeChannel instance\n" + "summary": [ + { + "kind": "text", + "text": "A RealtimeChannel instance" + } + ] }, "type": { "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.5.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, - 391, 392, 380, 396, 385, 393, 399, 395, 394, 401, - 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, - 451, 436, 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 80, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 36, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 84, - "character": 2 - } - ], - "signatures": [ - { - "id": 37, - "name": "new RealtimePresence", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Presence." - }, - "parameters": [ - { - "id": 38, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The RealtimeChannel" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" - } - }, - { - "id": 39, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" - }, - "type": { - "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 44, - "name": "caller", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 45, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 46, - "name": "onJoin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 68, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" - } - }, - { - "id": 47, - "name": "onLeave", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 69, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" - } - }, - { - "id": 48, - "name": "onSync", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 70, - "character": 4 - } - ], - "signatures": [ - { - "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, - { - "title": "Methods", - "kind": 2048, - "children": [48] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 50, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" - } - }, - { - "id": 43, - "name": "joinRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 42, - "name": "pendingDiffs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 65, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "RawPresenceDiff" - } - }, - "defaultValue": "[]" - }, - { - "id": 40, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 41, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ], - "name": "RealtimePresenceState", - "dereferenced": { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 605, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 75 - } - ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } - } - } - } - } - } - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.5.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, - 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, - 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, - 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 228, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 229, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 233, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 234, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 235, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 236, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 237, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [237] - } - ] - } - } - }, - { - "id": 238, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 239, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 240, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 241, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 242, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 244, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 246, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 250, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 247, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 251, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 252, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 253, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 254, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 256, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 257, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 114, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 119, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "T" - } - ], - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 258, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 430, - "character": 8 - } - ], - "signatures": [ - { - "id": 259, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a message into the channel." - }, - "parameters": [ - { - "id": 260, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Arguments to send to channel" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 263, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The name of the event being sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 433, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 264, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Payload to be sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 434, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 262, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of event to send" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 432, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] - } - ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 267, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Options to be used during the send process\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 268, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 105, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 107, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 109, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 110, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "id": 111, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 112, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 120, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 8 - } - ], - "signatures": [ - { - "id": 121, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 122, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 126, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 127, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 277, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 507, - "character": 2 - } - ], - "signatures": [ - { - "id": 278, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 279, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 130, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 335, - "character": 8 - } - ], - "signatures": [ - { - "id": 131, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 132, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 271, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 494, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 273, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" + "target": 617, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 457, + "id": 459, "name": "sendHeartbeat", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 + "line": 395, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L395" } ], "signatures": [ { - "id": 458, + "id": 460, "name": "sendHeartbeat", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." + "summary": [ + { + "kind": "text", + "text": "Sends a heartbeat message if the socket is connected." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 395, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L395" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 454, + "id": 456, "name": "setAuth", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 + "line": 369, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L369" } ], "signatures": [ { - "id": 455, + "id": 457, "name": "setAuth", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.\n\nIf param is null it will use the " + }, + { + "kind": "code", + "text": "`accessToken`" + }, + { + "kind": "text", + "text": " callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 369, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L369" + } + ], "parameters": [ { - "id": 456, + "id": 458, "name": "token", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string to override the token set on the client.\n" + "summary": [ + { + "kind": "text", + "text": "A JWT string to override the token set on the client." + } + ] }, "type": { "type": "union", @@ -80634,15 +70255,18 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -80651,9130 +70275,133 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [372] + "children": [373] }, { "title": "Properties", - "kind": 1024, "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, 399, - 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 + 419, 377, 378, 379, 402, 400, 399, 380, 411, 382, 392, 393, 381, 397, 398, 386, 394, + 401, 396, 395, 403, 404, 405, 390, 391, 422, 424, 423 ] }, { "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454 - ] + "children": [449, 425, 445, 429, 427, 461, 433, 447, 440, 453, 438, 435, 459, 456] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 + "line": 86, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L86" } ] }, { "id": 1, "name": "RealtimePresence", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "children": [ { "id": 36, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" } ], "signatures": [ { "id": 37, - "name": "new RealtimePresence", + "name": "RealtimePresence", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Initializes the Presence." + "summary": [ + { + "kind": "text", + "text": "Initializes the Presence." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 84, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" + } + ], "parameters": [ { "id": 38, "name": "channel", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The RealtimeChannel" + "summary": [ + { + "kind": "text", + "text": "The RealtimeChannel" + } + ] }, "type": { "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, - 518, 526, 521, 516, 515, 532, - 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 365, 364 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 362, 366, 369 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 539, 542, 540, 541, 538 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.0.signatures.0.parameters.0.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, - 391, 392, 380, 396, 385, 393, 399, 395, 394, 401, - 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, - 451, 436, 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 80, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.6.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, - 521, 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.0.signatures.0.parameters.0.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, - 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, - 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, - 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 228, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 229, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 233, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 234, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 235, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 236, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 237, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [237] - } - ] - } - } - }, - { - "id": 238, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 239, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 240, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 241, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 242, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 244, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 246, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 250, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 247, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 251, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 252, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 253, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 254, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 256, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 257, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 114, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 119, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "T" - } - ], - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 258, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 430, - "character": 8 - } - ], - "signatures": [ - { - "id": 259, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a message into the channel." - }, - "parameters": [ - { - "id": 260, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Arguments to send to channel" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 263, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The name of the event being sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 433, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 264, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Payload to be sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 434, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 262, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of event to send" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 432, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] - } - ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 267, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Options to be used during the send process\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 268, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 105, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 107, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 109, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 110, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "id": 111, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 112, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 120, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 8 - } - ], - "signatures": [ - { - "id": 121, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 122, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 126, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 127, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 277, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 507, - "character": 2 - } - ], - "signatures": [ - { - "id": 278, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 279, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 130, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 335, - "character": 8 - } - ], - "signatures": [ - { - "id": 131, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 132, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 271, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 494, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 273, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { "id": 39, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" + "summary": [ + { + "kind": "text", + "text": "The options,\n for example " + }, + { + "kind": "code", + "text": "`{events: {state: 'state', diff: 'diff'}}`" + } + ] }, "type": { "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOpts" + }, + "name": "PresenceOpts", + "package": "@types/phoenix" } } ], "type": { "type": "reference", - "id": 1, - "name": "default" + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] @@ -89782,14 +70409,15 @@ { "id": 44, "name": "caller", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 67, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L67" } ], "type": { @@ -89797,88 +70425,125 @@ "declaration": { "id": 45, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { "id": 46, "name": "onJoin", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 68, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L68" } ], "type": { "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnJoinCallback" + }, + "name": "PresenceOnJoinCallback", + "package": "@types/phoenix" } }, { "id": 47, "name": "onLeave", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 69, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L69" } ], "type": { "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnLeaveCallback" + }, + "name": "PresenceOnLeaveCallback", + "package": "@types/phoenix" } }, { "id": 48, "name": "onSync", - "kind": 2048, - "kindString": "Method", + "variant": "declaration", + "kind": 1024, "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 70, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 70, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" + } + ], + "signatures": [ + { + "id": 50, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 70, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, + "children": [46, 47, 48] + } + ], + "sources": [ { - "title": "Methods", - "kind": 2048, - "children": [48] + "fileName": "src/RealtimePresence.ts", + "line": 67, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L67" } ] } @@ -89886,9048 +70551,49 @@ "defaultValue": "..." }, { - "id": 50, + "id": 51, "name": "channel", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isPublic": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The RealtimeChannel" + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 84, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" + } + ], "type": { "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, - 521, 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.2.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, - 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, - 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, - 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 80, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.6.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, - 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.2.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, - 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, - 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 228, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 229, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 233, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 234, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 235, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 236, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 237, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [237] - } - ] - } - } - }, - { - "id": 238, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 239, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 240, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 241, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 242, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 244, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 246, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 250, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 247, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 251, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 252, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 253, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 254, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 256, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 257, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 114, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 119, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "T" - } - ], - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 258, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 430, - "character": 8 - } - ], - "signatures": [ - { - "id": 259, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a message into the channel." - }, - "parameters": [ - { - "id": 260, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Arguments to send to channel" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 263, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The name of the event being sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 433, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 264, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Payload to be sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 434, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 262, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of event to send" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 432, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] - } - ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 267, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Options to be used during the send process\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 268, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 105, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 107, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 109, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 110, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "id": 111, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 112, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 120, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 8 - } - ], - "signatures": [ - { - "id": 121, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 122, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 126, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 127, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 277, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 507, - "character": 2 - } - ], - "signatures": [ - { - "id": 278, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 279, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 130, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 335, - "character": 8 - } - ], - "signatures": [ - { - "id": 131, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 132, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 271, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 494, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 273, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { "id": 43, "name": "joinRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L66" } ], "type": { @@ -98948,21 +70614,27 @@ { "id": 42, "name": "pendingDiffs", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 65, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L65" } ], "type": { "type": "array", "elementType": { "type": "reference", - "name": "RawPresenceDiff" + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RawPresenceDiff" + }, + "name": "RawPresenceDiff", + "package": "@supabase/realtime-js" } }, "defaultValue": "[]" @@ -98970,162 +70642,34 @@ { "id": 40, "name": "state", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L64" } ], "type": { "type": "reference", - "id": 604, + "target": 608, "typeArguments": [ { "type": "reflection", "declaration": { "id": 41, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } ], "name": "RealtimePresenceState", - "dereferenced": { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 605, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 75 - } - ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } - } - } - } - } - } + "package": "@supabase/realtime-js" }, "defaultValue": "{}" } @@ -99133,99 +70677,106 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [36] }, { "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [44, 51, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L63" } ] }, { - "id": 358, + "id": 359, "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 359, + "id": 360, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 361, "name": "config", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L17" } ], "type": { "type": "reflection", "declaration": { - "id": 361, + "id": 362, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 362, + "id": 363, "name": "broadcast", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + "summary": [ + { + "kind": "text", + "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { "type": "reflection", "declaration": { - "id": 363, + "id": 364, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 366, "name": "ack", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -99233,7 +70784,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { @@ -99242,10 +70794,10 @@ } }, { - "id": 364, + "id": 365, "name": "self", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -99253,7 +70805,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { @@ -99265,52 +70818,58 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [365, 364] + "children": [366, 365] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ] } } }, { - "id": 366, + "id": 367, "name": "presence", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "key option is used to track presence payload across clients" + "summary": [ + { + "kind": "text", + "text": "key option is used to track presence payload across clients" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ], "type": { "type": "reflection", "declaration": { - "id": 367, + "id": 368, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 369, "name": "key", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -99318,7 +70877,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ], "type": { @@ -99330,36 +70890,42 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [368] + "children": [369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ] } } }, { - "id": 369, + "id": 370, "name": "private", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + "summary": [ + { + "kind": "text", + "text": "defines if the channel is private or not and if RLS policies will be used to check data" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 30, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L30" } ], "type": { @@ -99371,15 +70937,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] + "children": [363, 367, 370] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 17, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L17" } ] } @@ -99389,31 +70955,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [360] + "children": [361] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L16" } ] } } }, { - "id": 370, + "id": 371, "name": "RealtimeChannelSendResponse", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 88, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L88" } ], "type": { @@ -99435,317 +71002,257 @@ } }, { - "id": 513, + "id": 515, "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 + "line": 60, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L60" } ], "type": { "type": "reflection", "declaration": { - "id": 514, + "id": 516, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 520, - "name": "decode", + "id": 537, + "name": "accessToken", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 + "line": 76, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L76" } ], "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 + "type": "reflection", + "declaration": { + "id": 538, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 76, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L76" + } + ], + "signatures": [ + { + "id": 539, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" } }, { "id": 522, - "name": "headers", + "name": "decode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 + "line": 66, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L66" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { "id": 521, - "name": "reconnectAfterMs", + "name": "encode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 + "line": 65, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L65" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 516, - "name": "timeout", + "id": 534, + "name": "fetch", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 + "line": 73, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L73" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "Fetch" + }, + "name": "Fetch", + "package": "@supabase/realtime-js" + } + }, + { + "id": 524, + "name": "headers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 525, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "indexSignatures": [ + { + "id": 526, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "parameters": [ + { + "id": 527, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + }, + { + "id": 519, + "name": "heartbeatIntervalMs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 63, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L63" } ], "type": { @@ -99754,38 +71261,239 @@ } }, { - "id": 515, - "name": "transport", + "id": 532, + "name": "log_level", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 + "line": 71, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L71" } ], "type": { "type": "reference", - "name": "WebSocketLikeConstructor" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "LogLevel" + }, + "name": "LogLevel", + "package": "@supabase/realtime-js" } }, { - "id": 532, - "name": "worker", + "id": 520, + "name": "logger", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 + "line": 64, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L64" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 533, + "name": "logLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L72" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "LogLevel" + }, + "name": "LogLevel", + "package": "@supabase/realtime-js" + } + }, + { + "id": 528, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 529, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "indexSignatures": [ + { + "id": 530, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "parameters": [ + { + "id": 531, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + }, + { + "id": 523, + "name": "reconnectAfterMs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L67" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 518, + "name": "timeout", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 62, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L62" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 517, + "name": "transport", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 61, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L61" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "name": "WebSocketLikeConstructor", + "package": "@supabase/realtime-js" + } + }, + { + "id": 535, + "name": "worker", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L74" } ], "type": { @@ -99794,18 +71502,81 @@ } }, { - "id": 533, + "id": 536, "name": "workerUrl", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 + "line": 75, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L75" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 537, 522, 521, 534, 524, 519, 532, 520, 533, 528, 523, 518, 517, 535, 536 + ] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 60, + "character": 36, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L60" + } + ] + } + } + }, + { + "id": 540, + "name": "RealtimeMessage", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 32, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L32" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 541, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 543, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 34, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L34" } ], "type": { @@ -99814,107 +71585,57 @@ } }, { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 546, + "name": "join_ref", + "variant": "declaration", + "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 + "line": 37, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L37" } ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533] + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - }, - { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", + "id": 544, + "name": "payload", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 + "line": 35, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L35" + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 545, + "name": "ref", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 36, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L36" } ], "type": { @@ -99924,71 +71645,16 @@ }, { "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, "name": "topic", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 + "line": 33, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L33" } ], "type": { @@ -100000,49 +71666,51 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] + "children": [543, 546, 544, 545, 542] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 + "line": 32, + "character": 30, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L32" } ] } } }, { - "id": 543, + "id": 547, "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 67, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L67" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 549, + "id": 553, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" + "target": 623, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "package": "@supabase/realtime-js" }, "" ] @@ -100053,51 +71721,64 @@ "type": { "type": "reflection", "declaration": { - "id": 544, + "id": 548, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 545, + "id": 549, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of database change to listen to." + "summary": [ + { + "kind": "text", + "text": "The type of database change to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 73, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L73" } ], "type": { "type": "reference", - "id": 549, + "target": 553, "name": "T", - "dereferenced": {} + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 548, + "id": 552, "name": "filter", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Receive database changes when filter is matched." + "summary": [ + { + "kind": "text", + "text": "Receive database changes when filter is matched." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 85, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L85" } ], "type": { @@ -100106,19 +71787,25 @@ } }, { - "id": 546, + "id": 550, "name": "schema", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The database schema to listen to." + "summary": [ + { + "kind": "text", + "text": "The database schema to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 77, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L77" } ], "type": { @@ -100127,21 +71814,27 @@ } }, { - "id": 547, + "id": 551, "name": "table", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "The database table to listen to." + "summary": [ + { + "kind": "text", + "text": "The database table to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 81, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L81" } ], "type": { @@ -100153,78 +71846,91 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] + "children": [549, 552, 550, 551] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 69, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L69" } ] } } }, { - "id": 550, + "id": 554, "name": "RealtimePostgresChangesPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 554, + "id": 555, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 551, + "id": 556, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, - "character": 53 + "character": 53, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } ], - "indexSignature": { - "id": 552, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 553, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 557, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 62, + "character": 55, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } + ], + "parameters": [ + { + "id": 558, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -100233,598 +71939,124 @@ "type": "union", "types": [ { - "id": 555, + "type": "reference", + "target": 559, + "typeArguments": [ + { + "type": "reference", + "target": 555, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 41, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 564, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 561, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 41, - "character": 52 - } - ], - "indexSignature": { - "id": 562, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 563, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 557, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 621, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "" - ] - ] - } - }, - { - "id": 558, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 564, - "name": "T" - } - }, - { - "id": 559, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 560, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 45, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [557, 558, 559] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 42, - "character": 39 - } - ] - } - } - ] - } + "package": "@supabase/realtime-js" }, { - "id": 565, + "type": "reference", + "target": 569, + "typeArguments": [ + { + "type": "reference", + "target": 555, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 48, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 573, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 570, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 48, - "character": 52 - } - ], - "indexSignature": { - "id": 571, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 572, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 566, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 567, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 50, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 622, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "" - ] - ] - } - }, - { - "id": 568, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 51, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 573, - "name": "T" - } - }, - { - "id": 569, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 573, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [567, 568, 569] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 49, - "character": 39 - } - ] - } - } - ] - } + "package": "@supabase/realtime-js" }, { - "id": 574, - "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ + "type": "reference", + "target": 578, + "typeArguments": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 55, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 583, + "type": "reference", + "target": 555, "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 580, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 55, - "character": 52 - } - ], - "indexSignature": { - "id": 581, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 582, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 575, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 576, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 57, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 623, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "" - ] - ] - } - }, - { - "id": 577, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 578, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 58, - "character": 9 - } - ] - } - } - }, - { - "id": 579, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 59, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 583, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [576, 577, 579] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 56, - "character": 39 - } - ] - } - } - ] - } + "name": "RealtimePostgresDeletePayload", + "package": "@supabase/realtime-js" } ] } }, { - "id": 574, + "id": 578, "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 55, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 583, + "id": 584, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 585, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 55, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } ], - "indexSignature": { - "id": 581, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 582, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 586, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 55, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } + ], + "parameters": [ + { + "id": 587, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -100834,39 +72066,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 575, + "id": 579, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 576, + "id": 580, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 57, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L57" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 623, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + "target": 627, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", + "package": "@supabase/realtime-js" }, "" ] @@ -100874,76 +72113,84 @@ } }, { - "id": 577, + "id": 581, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 58, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L58" } ], "type": { "type": "reflection", "declaration": { - "id": 578, + "id": 582, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 58, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L58" } ] } } }, { - "id": 579, + "id": 583, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 59, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L59" } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, "typeArguments": [ { "type": "reference", - "id": 583, - "name": "T" + "target": 584, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "name": "Partial", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [576, 577, 579] + "children": [580, 581, 583] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 56, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L56" } ] } @@ -100952,63 +72199,76 @@ } }, { - "id": 555, + "id": 559, "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 41, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 564, + "id": 565, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 561, + "id": 566, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 41, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } ], - "indexSignature": { - "id": 562, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 563, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 567, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 41, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } + ], + "parameters": [ + { + "id": 568, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -101018,39 +72278,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 556, + "id": 560, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 557, + "id": 561, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L43" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 621, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + "target": 625, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", + "package": "@supabase/realtime-js" }, "" ] @@ -101058,50 +72325,55 @@ } }, { - "id": 558, + "id": 562, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L44" } ], "type": { "type": "reference", - "id": 564, - "name": "T" + "target": 565, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 559, + "id": 563, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L45" } ], "type": { "type": "reflection", "declaration": { - "id": 560, + "id": 564, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L45" } ] } @@ -101111,15 +72383,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [557, 558, 559] + "children": [561, 562, 563] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 42, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L42" } ] } @@ -101128,63 +72400,76 @@ } }, { - "id": 565, + "id": 569, "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 48, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 573, + "id": 574, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 570, + "id": 575, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 48, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } ], - "indexSignature": { - "id": 571, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 572, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 576, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } + ], + "parameters": [ + { + "id": 577, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -101194,39 +72479,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 566, + "id": 570, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 567, + "id": 571, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 50, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L50" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 622, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + "target": 626, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", + "package": "@supabase/realtime-js" }, "" ] @@ -101234,64 +72526,73 @@ } }, { - "id": 568, + "id": 572, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 51, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L51" } ], "type": { "type": "reference", - "id": 573, - "name": "T" + "target": 574, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 569, + "id": 573, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 52, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L52" } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, "typeArguments": [ { "type": "reference", - "id": 573, - "name": "T" + "target": 574, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "name": "Partial", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [567, 568, 569] + "children": [571, 572, 573] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 49, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L49" } ] } @@ -101300,460 +72601,74 @@ } }, { - "id": 584, + "id": 588, "name": "RealtimePresenceJoinPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 593, + "id": 594, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 590, + "id": 595, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, - "character": 50 + "character": 50, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } ], - "indexSignature": { - "id": 591, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 592, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 596, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 21, + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } + ], + "parameters": [ + { + "id": 597, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 588, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 593, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 586, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 626, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "" - ] - ] - } - }, - { - "id": 587, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "newPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 593, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [588, 586, 587, 589] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 21, - "character": 76 - } - ] - } - } - }, - { - "id": 594, - "name": "RealtimePresenceLeavePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 603, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 600, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 51 - } - ], - "indexSignature": { - "id": 601, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 602, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 598, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 603, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 596, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 627, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "" - ] - ] - } - }, - { - "id": 597, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 599, - "name": "leftPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 603, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [598, 596, 597, 599] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 77 - } - ] - } - } - }, - { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 } ] } @@ -101763,65 +72678,549 @@ "type": { "type": "reflection", "declaration": { - "id": 605, + "id": 589, "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 592, + "name": "currentPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 24, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L24" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 594, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + }, + { + "id": 590, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L22" + } + ], + "type": { + "type": "templateLiteral", + "head": "", + "tail": [ + [ + { + "type": "reference", + "target": 630, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", + "package": "@supabase/realtime-js" + }, + "" + ] + ] + } + }, + { + "id": 591, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L23" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 593, + "name": "newPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 25, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L25" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 594, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [592, 590, 591, 593] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 21, + "character": 76, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" + } + ] + } + } + }, + { + "id": 598, + "name": "RealtimePresenceLeavePayload", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "typeParameters": [ + { + "id": 604, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 605, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 51, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "indexSignatures": [ + { + "id": 606, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 53, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "parameters": [ + { + "id": 607, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 599, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 602, + "name": "currentPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 31, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L31" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 604, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + }, + { + "id": 600, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 29, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L29" + } + ], + "type": { + "type": "templateLiteral", + "head": "", + "tail": [ + [ + { + "type": "reference", + "target": 631, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", + "package": "@supabase/realtime-js" + }, + "" + ] + ] + } + }, + { + "id": 601, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 30, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L30" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 603, + "name": "leftPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 32, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L32" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 604, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [602, 600, 601, 603] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 77, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ] + } + } + }, + { + "id": 608, + "name": "RealtimePresenceState", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "typeParameters": [ + { + "id": 612, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 613, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 44, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "indexSignatures": [ + { + "id": 614, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 46, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "parameters": [ + { + "id": 615, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 616, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 69, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 609, + "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, - "character": 75 + "character": 75, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" } ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 610, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L18" + } + ], + "parameters": [ + { + "id": 611, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 612, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" } } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } } - } + ] } } }, { - "id": 613, + "id": 617, "name": "RealtimeRemoveChannelResponse", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 54, - "character": 12 + "line": 40, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L40" } ], "type": { @@ -101843,10 +73242,10 @@ } }, { - "id": 633, + "id": 637, "name": "REALTIME_CHANNEL_STATES", + "variant": "declaration", "kind": 32, - "kindString": "Variable", "flags": { "isConst": true }, @@ -101854,14 +73253,21 @@ { "fileName": "src/RealtimeChannel.ts", "line": 111, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L111" } ], "type": { "type": "query", "queryType": { "type": "reference", - "name": "CHANNEL_STATES" + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CHANNEL_STATES" + }, + "name": "CHANNEL_STATES", + "package": "@supabase/realtime-js", + "preferValues": true } }, "defaultValue": "CHANNEL_STATES" @@ -101870,32 +73276,1906 @@ "groups": [ { "title": "Enumerations", - "kind": 8, - "children": [614, 619, 624, 628] + "children": [618, 623, 628, 632] }, { "title": "Classes", - "kind": 128, - "children": [64, 371, 1] + "children": [65, 372, 1] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [358, 370, 513, 536, 543, 550, 574, 555, 565, 584, 594, 604, 613] + "children": [359, 371, 515, 540, 547, 554, 578, 559, 569, 588, 598, 608, 617] }, { "title": "Variables", - "kind": 32, - "children": [633] + "children": [637] } ], - "sources": [ + "packageName": "@supabase/realtime-js", + "readme": [ { - "fileName": "src/index.ts", - "line": 1, - "character": 0 + "kind": "text", + "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" + }, + { + "kind": "code", + "text": "```bash\nnpm install @supabase/realtime-js\n```" + }, + { + "kind": "text", + "text": "\n\n## Creating a Channel\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { RealtimeClient } from '@supabase/realtime-js'\n\nconst client = new RealtimeClient(REALTIME_URL, {\n params: {\n apikey: API_KEY\n },\n})\n\nconst channel = client.channel('test-channel', {})\n\nchannel.subscribe((status, err) => {\n if (status === 'SUBSCRIBED') {\n console.log('Connected!')\n }\n\n if (status === 'CHANNEL_ERROR') {\n console.log(`There was an error subscribing to channel: ${err.message}`)\n }\n\n if (status === 'TIMED_OUT') {\n console.log('Realtime server did not respond in time.')\n }\n\n if (status === 'CLOSED') {\n console.log('Realtime channel was unexpectedly closed.')\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n### Notes:\n\n- " + }, + { + "kind": "code", + "text": "`REALTIME_URL`" + }, + { + "kind": "text", + "text": " is " + }, + { + "kind": "code", + "text": "`'ws://localhost:4000/socket'`" + }, + { + "kind": "text", + "text": " when developing locally and " + }, + { + "kind": "code", + "text": "`'wss://.supabase.co/realtime/v1'`" + }, + { + "kind": "text", + "text": " when connecting to your Supabase project.\n- " + }, + { + "kind": "code", + "text": "`API_KEY`" + }, + { + "kind": "text", + "text": " is a JWT whose claims must contain " + }, + { + "kind": "code", + "text": "`exp`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " (existing database role).\n- Channel name can be any " + }, + { + "kind": "code", + "text": "`string`" + }, + { + "kind": "text", + "text": ".\n\n## Broadcast\n\nYour client can send and receive messages based on the " + }, + { + "kind": "code", + "text": "`event`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n### Notes:\n\n- Setting " + }, + { + "kind": "code", + "text": "`ack`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the " + }, + { + "kind": "code", + "text": "`channel.send`" + }, + { + "kind": "text", + "text": " promise will resolve once server replies with acknowledgement that it received the broadcast message request.\n- Setting " + }, + { + "kind": "code", + "text": "`self`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the client will receive the broadcast message it sent out.\n- Setting " + }, + { + "kind": "code", + "text": "`private`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the client will use RLS to determine if the user can connect or not to a given channel.\n\n## Presence\n\nYour client can track and sync state that's stored in the channel.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel(\n 'presence-test',\n {\n config: {\n presence: {\n key: ''\n }\n }\n }\n)\n\nchannel.on('presence', { event: 'sync' }, () => {\n console.log('Online users: ', channel.presenceState())\n})\n\nchannel.on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('New users have joined: ', newPresences)\n})\n\nchannel.on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Users have left: ', leftPresences)\n})\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n const status = await channel.track({ 'user_id': 1 })\n console.log(status)\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n## Postgres CDC\n\nReceive database changes on the client.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('db-changes')\n\nchannel.on('postgres_changes', { event: '*', schema: 'public' }, (payload) => {\n console.log('All changes in public schema: ', payload)\n})\n\nchannel.on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'messages' }, (payload) => {\n console.log('All inserts in messages table: ', payload)\n})\n\nchannel.on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' }, (payload) => {\n console.log('All updates on users table when username is Realtime: ', payload)\n})\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n console.log('Ready to receive database changes!')\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n## Get All Channels\n\nYou can see all the channels that your client has instantiatied.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nclient.getChannels()\n```" + }, + { + "kind": "text", + "text": "\n\n## Cleanup\n\nIt is highly recommended that you clean up your channels after you're done with them.\n\n- Remove a single channel\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('some-channel-to-remove')\n\nchannel.subscribe()\n\nclient.removeChannel(channel)\n```" + }, + { + "kind": "text", + "text": "\n\n- Remove all channels\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel1 = client.channel('a-channel-to-remove')\nconst channel2 = client.channel('another-channel-to-remove')\n\nchannel1.subscribe()\nchannel2.subscribe()\n\nclient.removeAllChannels()\n```" + }, + { + "kind": "text", + "text": "\n\n## Credits\n\nThis repo draws heavily from [phoenix-js](https://github.com/phoenixframework/phoenix/tree/master/assets/js/phoenix).\n\n## License\n\nMIT." } - ] + ], + "symbolIdMap": { + "0": { + "sourceFileName": "src/index.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default" + }, + "36": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.__constructor" + }, + "37": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default" + }, + "38": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "channel" + }, + "39": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "opts" + }, + "40": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.state" + }, + "41": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "42": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.pendingDiffs" + }, + "43": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.joinRef" + }, + "44": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.caller" + }, + "45": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "46": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onJoin" + }, + "47": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onLeave" + }, + "48": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onSync" + }, + "49": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "50": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "51": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.channel" + }, + "65": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default" + }, + "76": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.__constructor" + }, + "77": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default" + }, + "78": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "topic" + }, + "79": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "params" + }, + "80": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "socket" + }, + "81": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.bindings" + }, + "82": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "83": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "85": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "86": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "87": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.filter" + }, + "88": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "89": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "91": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.callback" + }, + "92": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.id" + }, + "93": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.timeout" + }, + "94": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.state" + }, + "95": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.joinedOnce" + }, + "96": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.joinPush" + }, + "97": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.rejoinTimer" + }, + "98": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.pushBuffer" + }, + "99": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presence" + }, + "100": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.broadcastEndpointURL" + }, + "101": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subTopic" + }, + "102": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.private" + }, + "103": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.topic" + }, + "104": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.params" + }, + "105": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.socket" + }, + "106": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subscribe" + }, + "107": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subscribe" + }, + "108": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "109": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "110": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "111": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "status" + }, + "112": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "err" + }, + "113": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "timeout" + }, + "114": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presenceState" + }, + "115": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presenceState" + }, + "116": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "117": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "118": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "120": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "121": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.track" + }, + "122": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.track" + }, + "123": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "124": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "125": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "127": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "128": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "129": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "131": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.untrack" + }, + "132": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.untrack" + }, + "133": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "134": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "135": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "137": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "138": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "139": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "140": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "141": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "142": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "143": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "144": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "145": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "146": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "147": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "148": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "149": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "151": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "152": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "153": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "154": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "155": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "156": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "157": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "158": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "159": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "160": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "161": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "162": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "164": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "165": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "166": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "167": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "168": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "169": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "170": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "171": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "172": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "173": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "174": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "175": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "177": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "178": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "179": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "180": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "181": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "182": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "183": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "184": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "185": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "186": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "188": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "189": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "190": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "191": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "192": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "193": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "194": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "195": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "196": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "197": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "199": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "200": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "201": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "202": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "203": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "204": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "205": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "206": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "207": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "208": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "210": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "211": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "212": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "213": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "214": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "215": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "216": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "217": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "218": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "219": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "220": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "221": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "222": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "223": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "224": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "225": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "226": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "227": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "228": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "230": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "231": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "232": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "233": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "235": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "236": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "237": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "238": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "239": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "240": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "241": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "242": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "243": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "244": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "245": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "246": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.payload" + }, + "247": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "248": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "249": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "250": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "252": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "253": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "254": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "255": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "256": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "257": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "258": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "259": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.send" + }, + "260": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.send" + }, + "261": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "args" + }, + "262": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "263": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "264": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "265": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.payload" + }, + "266": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "268": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "269": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "270": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "272": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.updateJoinPayload" + }, + "273": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.updateJoinPayload" + }, + "274": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "275": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "276": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "278": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.unsubscribe" + }, + "279": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.unsubscribe" + }, + "280": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "timeout" + }, + "359": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimeChannelOptions" + }, + "360": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "361": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.config" + }, + "362": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "363": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.broadcast" + }, + "364": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "365": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.self" + }, + "366": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.ack" + }, + "367": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.presence" + }, + "368": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "369": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.key" + }, + "370": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.private" + }, + "371": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimeChannelSendResponse" + }, + "372": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default" + }, + "373": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.__constructor" + }, + "374": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default" + }, + "375": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "endPoint" + }, + "376": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "options" + }, + "377": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.accessTokenValue" + }, + "378": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.apiKey" + }, + "379": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channels" + }, + "380": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endPoint" + }, + "381": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.httpEndpoint" + }, + "382": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.headers" + }, + "383": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "384": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "386": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.params" + }, + "387": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "388": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "390": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.timeout" + }, + "391": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.transport" + }, + "392": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.heartbeatIntervalMs" + }, + "393": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.heartbeatTimer" + }, + "394": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.pendingHeartbeatRef" + }, + "395": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.ref" + }, + "396": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.reconnectTimer" + }, + "397": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.logger" + }, + "398": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.logLevel" + }, + "399": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.encode" + }, + "400": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.decode" + }, + "401": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.reconnectAfterMs" + }, + "402": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.conn" + }, + "403": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendBuffer" + }, + "404": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.serializer" + }, + "405": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.stateChangeCallbacks" + }, + "406": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "407": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.open" + }, + "408": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.close" + }, + "409": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.error" + }, + "410": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.message" + }, + "411": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.fetch" + }, + "412": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "fetch" + }, + "413": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "fetch" + }, + "414": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "input" + }, + "415": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "init" + }, + "416": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "fetch" + }, + "417": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "input" + }, + "418": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "init" + }, + "419": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.accessToken" + }, + "420": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "421": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "422": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.worker" + }, + "423": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.workerUrl" + }, + "424": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.workerRef" + }, + "425": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connect" + }, + "426": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connect" + }, + "427": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endpointURL" + }, + "428": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endpointURL" + }, + "429": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.disconnect" + }, + "430": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.disconnect" + }, + "431": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "code" + }, + "432": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "reason" + }, + "433": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.getChannels" + }, + "434": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.getChannels" + }, + "435": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeChannel" + }, + "436": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeChannel" + }, + "437": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "channel" + }, + "438": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeAllChannels" + }, + "439": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeAllChannels" + }, + "440": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.log" + }, + "441": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.log" + }, + "442": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "kind" + }, + "443": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "msg" + }, + "444": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "data" + }, + "445": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connectionState" + }, + "446": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connectionState" + }, + "447": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnected" + }, + "448": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnected" + }, + "449": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channel" + }, + "450": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channel" + }, + "451": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "topic" + }, + "452": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "params" + }, + "453": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.push" + }, + "454": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.push" + }, + "455": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "data" + }, + "456": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.setAuth" + }, + "457": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.setAuth" + }, + "458": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "token" + }, + "459": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendHeartbeat" + }, + "460": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendHeartbeat" + }, + "461": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.flushSendBuffer" + }, + "462": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.flushSendBuffer" + }, + "515": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeClientOptions" + }, + "516": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "517": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.transport" + }, + "518": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.timeout" + }, + "519": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.heartbeatIntervalMs" + }, + "520": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.logger" + }, + "521": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.encode" + }, + "522": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.decode" + }, + "523": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.reconnectAfterMs" + }, + "524": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.headers" + }, + "525": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "526": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "528": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.params" + }, + "529": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "530": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "532": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.log_level" + }, + "533": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.logLevel" + }, + "534": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.fetch" + }, + "535": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.worker" + }, + "536": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.workerUrl" + }, + "537": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.accessToken" + }, + "538": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "539": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "540": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeMessage" + }, + "541": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "542": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.topic" + }, + "543": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.event" + }, + "544": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.payload" + }, + "545": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.ref" + }, + "546": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.join_ref" + }, + "547": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesFilter" + }, + "548": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "549": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "550": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.schema" + }, + "551": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.table" + }, + "552": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.filter" + }, + "553": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "554": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayload" + }, + "555": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "556": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "557": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "559": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresInsertPayload" + }, + "560": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "561": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "562": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "563": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "564": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "565": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "566": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "567": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "569": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresUpdatePayload" + }, + "570": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "571": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "572": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "573": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "574": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "575": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "576": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "578": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresDeletePayload" + }, + "579": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "580": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "581": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "582": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "583": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "584": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "585": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "586": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "588": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceJoinPayload" + }, + "589": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "590": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.event" + }, + "591": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.key" + }, + "592": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.currentPresences" + }, + "593": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.newPresences" + }, + "594": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "595": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "596": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "598": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceLeavePayload" + }, + "599": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "600": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.event" + }, + "601": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.key" + }, + "602": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.currentPresences" + }, + "603": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.leftPresences" + }, + "604": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "605": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "606": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "608": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceState" + }, + "609": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "610": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "612": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "613": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "614": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "616": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "617": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeRemoveChannelResponse" + }, + "618": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES" + }, + "619": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" + }, + "620": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" + }, + "621": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" + }, + "622": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" + }, + "623": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" + }, + "624": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" + }, + "625": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + }, + "626": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + }, + "627": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + }, + "628": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" + }, + "629": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" + }, + "630": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" + }, + "631": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" + }, + "632": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES" + }, + "633": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" + }, + "634": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" + }, + "635": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" + }, + "636": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" + }, + "637": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_CHANNEL_STATES" + } + }, + "files": { + "entries": { + "1": "src/index.ts" + }, + "reflections": { + "1": 0 + } + } }, { "id": 0, diff --git a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json b/apps/docs/spec/enrichments/tsdoc_v2/realtime.json index 08613f9142d..53cfb41533f 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/realtime.json @@ -1,2027 +1,633 @@ { "id": 0, "name": "@supabase/realtime-js", + "variant": "project", "kind": 1, - "kindString": "Project", "flags": {}, - "originalName": "", "children": [ { - "id": 614, + "id": 618, "name": "REALTIME_LISTEN_TYPES", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 615, + "id": 619, "name": "BROADCAST", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 98, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L98" } ], "type": { "type": "literal", "value": "broadcast" - }, - "defaultValue": "\"broadcast\"" + } }, { - "id": 617, + "id": 621, "name": "POSTGRES_CHANGES", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 100, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L100" } ], "type": { "type": "literal", "value": "postgres_changes" - }, - "defaultValue": "\"postgres_changes\"" + } }, { - "id": 616, + "id": 620, "name": "PRESENCE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L99" } ], "type": { "type": "literal", "value": "presence" - }, - "defaultValue": "\"presence\"" + } }, { - "id": 618, + "id": 622, "name": "SYSTEM", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L101" } ], "type": { "type": "literal", "value": "system" - }, - "defaultValue": "\"system\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [615, 617, 616, 618] + "children": [619, 621, 620, 622] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 97, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L97" } ] }, { - "id": 619, + "id": 623, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 620, + "id": 624, "name": "ALL", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L91" } ], "type": { "type": "literal", "value": "*" - }, - "defaultValue": "\"*\"" + } }, { - "id": 623, + "id": 627, "name": "DELETE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L94" } ], "type": { "type": "literal", "value": "DELETE" - }, - "defaultValue": "\"DELETE\"" + } }, { - "id": 621, + "id": 625, "name": "INSERT", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 92, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L92" } ], "type": { "type": "literal", "value": "INSERT" - }, - "defaultValue": "\"INSERT\"" + } }, { - "id": 622, + "id": 626, "name": "UPDATE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 93, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L93" } ], "type": { "type": "literal", "value": "UPDATE" - }, - "defaultValue": "\"UPDATE\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [620, 623, 621, 622] + "children": [624, 627, 625, 626] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 90, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L90" } ] }, { - "id": 624, + "id": 628, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 626, + "id": 630, "name": "JOIN", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L37" } ], "type": { "type": "literal", "value": "join" - }, - "defaultValue": "\"join\"" + } }, { - "id": 627, + "id": 631, "name": "LEAVE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L38" } ], "type": { "type": "literal", "value": "leave" - }, - "defaultValue": "\"leave\"" + } }, { - "id": 625, + "id": 629, "name": "SYNC", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L36" } ], "type": { "type": "literal", "value": "sync" - }, - "defaultValue": "\"sync\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [626, 627, 625] + "children": [630, 631, 629] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 35, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L35" } ] }, { - "id": 628, + "id": 632, "name": "REALTIME_SUBSCRIBE_STATES", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 632, + "id": 636, "name": "CHANNEL_ERROR", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 108, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L108" } ], "type": { "type": "literal", "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" + } }, { - "id": 631, + "id": 635, "name": "CLOSED", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 107, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L107" } ], "type": { "type": "literal", "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" + } }, { - "id": 629, + "id": 633, "name": "SUBSCRIBED", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 105, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L105" } ], "type": { "type": "literal", "value": "SUBSCRIBED" - }, - "defaultValue": "\"SUBSCRIBED\"" + } }, { - "id": 630, + "id": 634, "name": "TIMED_OUT", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 106, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L106" } ], "type": { "type": "literal", "value": "TIMED_OUT" - }, - "defaultValue": "\"TIMED_OUT\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [632, 631, 629, 630] + "children": [636, 635, 633, 634] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 104, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L104" } ] }, { - "id": 64, + "id": 65, "name": "RealtimeChannel", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + "summary": [ + { + "kind": "text", + "text": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + } + ] }, "children": [ { - "id": 75, + "id": 76, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 147, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L147" } ], "signatures": [ { - "id": 76, - "name": "new RealtimeChannel", + "id": 77, + "name": "RealtimeChannel", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 147, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L147" + } + ], "parameters": [ { - "id": 77, + "id": 78, "name": "topic", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 78, + "id": 79, "name": "params", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions" + "target": 359, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" }, "defaultValue": "..." }, { - "id": 79, + "id": 80, "name": "socket", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 371, - "name": "default" + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 80, + "id": 81, "name": "bindings", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 128, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L128" } ], "type": { "type": "reflection", "declaration": { - "id": 81, + "id": 82, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 128, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L128" + } + ], + "indexSignatures": [ + { + "id": 83, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 129, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L129" } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { + ], + "parameters": [ + { "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "name": "key", + "variant": "param", + "kind": 32768, "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 85, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 91, + "name": "callback", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 132, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L132" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { + }, + { + "id": 87, + "name": "filter", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" + } + ], + "type": { + "type": "reflection", + "declaration": { "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "parameters": [ + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" + } + ], + "indexSignatures": [ { "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, "name": "__index", + "variant": "signature", "kind": 8192, - "kindString": "Index signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" + } + ], "parameters": [ { - "id": 228, + "id": 90, "name": "key", + "variant": "param", "kind": 32768, "flags": {}, "type": { @@ -2035,7 +641,794 @@ "name": "any" } } - } + ] + } + } + }, + { + "id": 92, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 133, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L133" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 86, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L130" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [91, 87, 92, 86] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 129, + "character": 19, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L129" + } + ] + } + } + } + } + ] + } + }, + "defaultValue": "{}" + }, + { + "id": 100, + "name": "broadcastEndpointURL", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 143, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L143" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 95, + "name": "joinedOnce", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 138, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L138" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 96, + "name": "joinPush", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 139, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L139" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 104, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 150, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L150" + } + ], + "type": { + "type": "reference", + "target": 359, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" + }, + "defaultValue": "..." + }, + { + "id": 99, + "name": "presence", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 142, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L142" + } + ], + "type": { + "type": "reference", + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 102, + "name": "private", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L145" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 98, + "name": "pushBuffer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 141, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L141" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + "defaultValue": "[]" + }, + { + "id": 97, + "name": "rejoinTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 140, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L140" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 105, + "name": "socket", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 151, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L151" + } + ], + "type": { + "type": "reference", + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 94, + "name": "state", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 137, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L137" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CHANNEL_STATES" + }, + "name": "CHANNEL_STATES", + "package": "@supabase/realtime-js" + }, + "defaultValue": "CHANNEL_STATES.closed" + }, + { + "id": 101, + "name": "subTopic", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L144" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 93, + "name": "timeout", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 136, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L136" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 103, + "name": "topic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 149, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L149" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 137, + "name": "on", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 350, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L350" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 391, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L391" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 414, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L414" + } + ], + "signatures": [ + { + "id": 138, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 350, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L350" + } + ], + "parameters": [ + { + "id": 139, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 140, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 141, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 142, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 352, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L352" + } + ], + "type": { + "type": "literal", + "value": "sync" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [142] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 352, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L352" + } + ] + } + } + }, + { + "id": 143, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 144, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 353, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L353" + } + ], + "signatures": [ + { + "id": 145, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 353, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L353" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 146, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "typeParameters": [ + { + "id": 147, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 148, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "indexSignatures": [ + { + "id": 149, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "parameters": [ + { + "id": 150, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 151, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 152, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 153, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 154, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 357, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L357" + } + ], + "type": { + "type": "literal", + "value": "join" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [154] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 357, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L357" + } + ] + } + } + }, + { + "id": 155, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 156, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 358, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L358" + } + ], + "signatures": [ + { + "id": 157, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 358, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L358" + } + ], + "parameters": [ + { + "id": 158, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 588, + "typeArguments": [ + { + "type": "reference", + "target": 147, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceJoinPayload", + "package": "@supabase/realtime-js" } } ], @@ -2051,96 +1444,1087 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 229, + "id": 159, "name": "on", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ { - "id": 233, + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + } + ], + "typeParameters": [ + { + "id": 160, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 230, + "id": 161, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" } - } + ], + "indexSignatures": [ + { + "id": 162, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + } + ], + "parameters": [ + { + "id": 163, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } ], "parameters": [ { - "id": 234, + "id": 164, "name": "type", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 165, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 167, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 362, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L362" + } + ], + "type": { + "type": "literal", + "value": "leave" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [167] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 362, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L362" + } + ] + } + } + }, + { + "id": 168, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 169, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 363, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L363" + } + ], + "signatures": [ + { + "id": 170, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 363, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L363" + } + ], + "parameters": [ + { + "id": 171, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 598, + "typeArguments": [ + { + "type": "reference", + "target": 160, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceLeavePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 172, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "typeParameters": [ + { + "id": 173, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 174, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "indexSignatures": [ + { + "id": 175, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "parameters": [ + { + "id": 176, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 177, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 178, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "*" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 179, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 368, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L368" + } + ], + "signatures": [ + { + "id": 181, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 368, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L368" + } + ], + "parameters": [ + { + "id": 182, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 554, + "typeArguments": [ + { + "type": "reference", + "target": 173, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresChangesPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 183, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "typeParameters": [ + { + "id": 184, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 185, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "indexSignatures": [ + { + "id": 186, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "parameters": [ + { + "id": 187, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 188, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 189, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "INSERT" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 190, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 191, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L373" + } + ], + "signatures": [ + { + "id": 192, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L373" + } + ], + "parameters": [ + { + "id": 193, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 559, + "typeArguments": [ + { + "type": "reference", + "target": 184, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresInsertPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 194, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "typeParameters": [ + { + "id": 195, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 196, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "indexSignatures": [ + { + "id": 197, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "parameters": [ + { + "id": 198, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 199, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 200, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "UPDATE" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 201, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 202, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L378" + } + ], + "signatures": [ + { + "id": 203, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L378" + } + ], + "parameters": [ + { + "id": 204, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 569, + "typeArguments": [ + { + "type": "reference", + "target": 195, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresUpdatePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 205, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "typeParameters": [ + { + "id": 206, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 207, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "indexSignatures": [ + { + "id": 208, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "parameters": [ + { + "id": 209, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 210, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 211, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "DELETE" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 212, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 213, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L383" + } + ], + "signatures": [ + { + "id": 214, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L383" + } + ], + "parameters": [ + { + "id": 215, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 578, + "typeArguments": [ + { + "type": "reference", + "target": 206, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresDeletePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 216, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 391, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L391" + } + ], + "parameters": [ + { + "id": 217, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." + } + ] + }, "type": { "type": "literal", "value": "broadcast" } }, { - "id": 235, + "id": 218, "name": "filter", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom object specific to the Realtime feature detailing which payloads to receive." + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 236, + "id": 219, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 237, + "id": 220, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 + "line": 393, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L393" } ], "type": { @@ -2152,61 +2536,93 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [237] + "children": [220] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 393, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L393" } ] } } }, { - "id": 238, + "id": 221, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Function to be invoked when event handler is triggered." + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 239, + "id": 222, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], "signatures": [ { - "id": 240, + "id": 223, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], "parameters": [ { - "id": 241, + "id": 224, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 242, + "id": 225, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 244, + "id": 227, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 + "line": 396, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L396" } ], "type": { @@ -2215,35 +2631,17 @@ } }, { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, + "id": 226, "name": "type", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 + "line": 395, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L395" } ], "type": { @@ -2255,8 +2653,49 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] + "children": [227, 226] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], + "indexSignatures": [ + { + "id": 228, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 397, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L397" + } + ], + "parameters": [ + { + "id": 229, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } } ] } @@ -2275,64 +2714,398 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 246, + "id": 230, "name": "on", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ { - "id": 250, + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + } + ], + "typeParameters": [ + { + "id": 231, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 247, + "id": 232, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" } - } + ], + "indexSignatures": [ + { + "id": 233, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + } + ], + "parameters": [ + { + "id": 234, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } ], "parameters": [ { - "id": 251, + "id": 235, "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "broadcast" + } + }, + { + "id": 236, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 238, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 402, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L402" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [238] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 402, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L402" + } + ] + } + } + }, + { + "id": 239, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 240, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ], + "signatures": [ + { + "id": 241, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ], + "parameters": [ + { + "id": 242, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 243, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 245, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 405, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L405" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 246, + "name": "payload", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 406, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L406" + } + ], + "type": { + "type": "reference", + "target": 231, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + }, + { + "id": 244, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 404, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L404" + } + ], + "type": { + "type": "literal", + "value": "broadcast" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [245, 246, 244] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 247, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "typeParameters": [ + { + "id": 248, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 249, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "indexSignatures": [ + { + "id": 250, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "parameters": [ + { + "id": 251, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 252, + "name": "type", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "literal", @@ -2340,49 +3113,65 @@ } }, { - "id": 252, + "id": 253, "name": "filter", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 253, + "id": 254, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } }, { - "id": 254, + "id": 255, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 256, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 412, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L412" + } + ], "signatures": [ { - "id": 256, + "id": 257, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 412, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L412" + } + ], "parameters": [ { - "id": 257, + "id": 258, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -2402,79 +3191,109 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 113, + "id": 114, "name": "presenceState", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 315, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L315" } ], "signatures": [ { - "id": 114, + "id": 115, "name": "presenceState", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "sources": [ { - "id": 119, + "fileName": "src/RealtimeChannel.ts", + "line": 315, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L315" + } + ], + "typeParameters": [ + { + "id": 116, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 115, + "id": 117, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 316, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L316" } - } + ], + "indexSignatures": [ + { + "id": 118, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 316, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L316" + } + ], + "parameters": [ + { + "id": 119, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "default": { "type": "reflection", "declaration": { - "id": 118, + "id": 120, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } @@ -2482,75 +3301,103 @@ ], "type": { "type": "reference", - "id": 604, + "target": 608, "typeArguments": [ { "type": "reference", - "id": 119, - "name": "T" + "target": 116, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "name": "RealtimePresenceState" + "name": "RealtimePresenceState", + "package": "@supabase/realtime-js" } } ] }, { - "id": 258, + "id": 259, "name": "send", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 430, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L430" } ], "signatures": [ { - "id": 259, + "id": 260, "name": "send", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a message into the channel." + "summary": [ + { + "kind": "text", + "text": "Sends a message into the channel." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 430, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L430" + } + ], "parameters": [ { - "id": 260, + "id": 261, "name": "args", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Arguments to send to channel" + "summary": [ + { + "kind": "text", + "text": "Arguments to send to channel" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 262, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 263, + "id": 264, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The name of the event being sent" + "summary": [ + { + "kind": "text", + "text": "The name of the event being sent" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 433, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L433" } ], "type": { @@ -2559,21 +3406,27 @@ } }, { - "id": 264, + "id": 265, "name": "payload", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Payload to be sent" + "summary": [ + { + "kind": "text", + "text": "Payload to be sent" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 434, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L434" } ], "type": { @@ -2582,19 +3435,25 @@ } }, { - "id": 262, + "id": 263, "name": "type", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of event to send" + "summary": [ + { + "kind": "text", + "text": "The type of event to send" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 432, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L432" } ], "type": { @@ -2619,76 +3478,118 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] + "children": [264, 265, 263] } ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 431, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L431" } - } + ], + "indexSignatures": [ + { + "id": 266, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 435, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L435" + } + ], + "parameters": [ + { + "id": 267, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } }, { - "id": 267, + "id": 268, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Options to be used during the send process\n" + "summary": [ + { + "kind": "text", + "text": "Options to be used during the send process" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 269, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 437, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L437" } - } + ], + "indexSignatures": [ + { + "id": 270, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 437, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L437" + } + ], + "parameters": [ + { + "id": 271, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -2696,93 +3597,131 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 105, + "id": 106, "name": "subscribe", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 213, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L213" } ], "signatures": [ { - "id": 106, + "id": 107, "name": "subscribe", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Subscribe registers your client with the server" + "summary": [ + { + "kind": "text", + "text": "Subscribe registers your client with the server" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 213, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L213" + } + ], "parameters": [ { - "id": 107, + "id": 108, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 109, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 214, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L214" + } + ], "signatures": [ { - "id": 109, + "id": 110, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 214, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L214" + } + ], "parameters": [ { - "id": 110, + "id": 111, "name": "status", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" + "target": 632, + "name": "REALTIME_SUBSCRIBE_STATES", + "package": "@supabase/realtime-js" } }, { - "id": 111, + "id": 112, "name": "err", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" } } ], @@ -2796,10 +3735,10 @@ } }, { - "id": 112, + "id": 113, "name": "timeout", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -2810,110 +3749,159 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 120, + "id": 121, "name": "track", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 321, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L321" } ], "signatures": [ { - "id": 121, + "id": 122, "name": "track", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 321, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L321" + } + ], "parameters": [ { - "id": 122, + "id": 123, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 123, + "id": 124, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 322, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L322" } - } + ], + "indexSignatures": [ + { + "id": 125, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 322, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L322" + } + ], + "parameters": [ + { + "id": 126, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } }, { - "id": 126, + "id": 127, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 127, + "id": 128, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 323, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L323" } - } + ], + "indexSignatures": [ + { + "id": 129, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 323, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L323" + } + ], + "parameters": [ + { + "id": 130, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -2921,50 +3909,75 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 277, + "id": 278, "name": "unsubscribe", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 507, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L507" } ], "signatures": [ { - "id": 278, + "id": 279, "name": "unsubscribe", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" + "summary": [ + { + "kind": "text", + "text": "Leaves the channel.\n\nUnsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a " + }, + { + "kind": "code", + "text": "`receive`" + }, + { + "kind": "text", + "text": " hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 507, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L507" + } + ], "parameters": [ { - "id": 279, + "id": 280, "name": "timeout", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -2975,6 +3988,10 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "union", @@ -2994,71 +4011,98 @@ ] } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 130, + "id": 131, "name": "untrack", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 335, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L335" } ], "signatures": [ { - "id": 131, + "id": 132, "name": "untrack", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 335, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L335" + } + ], "parameters": [ { - "id": 132, + "id": 133, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 133, + "id": 134, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 336, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L336" } - } + ], + "indexSignatures": [ + { + "id": 135, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 336, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L336" + } + ], + "parameters": [ + { + "id": 136, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -3066,78 +4110,110 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 271, + "id": 272, "name": "updateJoinPayload", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 494, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" } ], "signatures": [ { - "id": 272, + "id": 273, "name": "updateJoinPayload", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" + } + ], "parameters": [ { - "id": 273, + "id": 274, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 275, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 29, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" } - } + ], + "indexSignatures": [ + { + "id": 276, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 31, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" + } + ], + "parameters": [ + { + "id": 277, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } @@ -3153,67 +4229,84 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [75] + "children": [76] }, { "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] + "children": [81, 100, 95, 96, 104, 99, 102, 98, 97, 105, 94, 101, 93, 103] }, { "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] + "children": [137, 114, 259, 106, 121, 278, 131, 272] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 127, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L127" } ] }, { - "id": 371, + "id": 372, "name": "RealtimeClient", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "children": [ { - "id": 372, + "id": 373, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L144" } ], "signatures": [ { - "id": 373, - "name": "new RealtimeClient", + "id": 374, + "name": "RealtimeClient", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Initializes the Socket." + "summary": [ + { + "kind": "text", + "text": "Initializes the Socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L144" + } + ], "parameters": [ { - "id": 374, + "id": 375, "name": "endPoint", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + "summary": [ + { + "kind": "text", + "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + } + ] }, "type": { "type": "intrinsic", @@ -3221,39 +4314,125 @@ } }, { - "id": 375, + "id": 376, "name": "options", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "id": 513, - "name": "RealtimeClientOptions" + "target": 515, + "name": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "highlightedProperties": { + "transport": [ + { + "kind": "text", + "text": "The Websocket Transport, for example WebSocket. This can be a custom implementation" + } + ], + "timeout": [ + { + "kind": "text", + "text": "The default timeout in milliseconds to trigger push timeouts." + } + ], + "params": [ + { + "kind": "text", + "text": "The optional params to pass when connecting." + } + ], + "headers": [ + { + "kind": "text", + "text": "The optional headers to pass when connecting." + } + ], + "heartbeatIntervalMs": [ + { + "kind": "text", + "text": "The millisec interval to send a heartbeat message." + } + ], + "logger": [ + { + "kind": "text", + "text": "The optional function for specialized logging, ie: logger: (kind, msg, data) => { console.log(" + }, + { + "kind": "code", + "text": "`${kind}: ${msg}`" + }, + { + "kind": "text", + "text": ", data) }" + } + ], + "logLevel": [ + { + "kind": "text", + "text": "Sets the log level for Realtime" + } + ], + "encode": [ + { + "kind": "text", + "text": "The function to encode outgoing messages. Defaults to JSON: (payload, callback) => callback(JSON.stringify(payload))" + } + ], + "decode": [ + { + "kind": "text", + "text": "The function to decode incoming messages. Defaults to Serializer's decode." + } + ], + "reconnectAfterMs": [ + { + "kind": "text", + "text": "he optional function that returns the millsec reconnect interval. Defaults to stepped backoff off." + } + ], + "worker": [ + { + "kind": "text", + "text": "Use Web Worker to set a side flow. Defaults to false." + } + ], + "workerUrl": [ + { + "kind": "text", + "text": "The URL of the worker script. Defaults to https://realtime.supabase.com/worker.js that includes a heartbeat event call to keep the connection alive." + } + ] + } } } ], "type": { "type": "reference", - "id": 371, - "name": "default" + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 417, + "id": 419, "name": "accessToken", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" } ], "type": { @@ -3266,20 +4445,40 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 420, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" + } + ], "signatures": [ { - "id": 419, + "id": 421, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "union", @@ -3295,9 +4494,8 @@ ] } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -3307,45 +4505,18 @@ }, "defaultValue": "null" }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, { "id": 377, - "name": "apiKey", + "name": "accessTokenValue", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 + "line": 87, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L87" } ], "type": { @@ -3365,38 +4536,71 @@ }, { "id": 378, - "name": "channels", + "name": "apiKey", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 + "line": 88, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L88" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 379, + "name": "channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 89, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L89" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, "defaultValue": "[]" }, { - "id": 400, + "id": 402, "name": "conn", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 + "line": 106, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L106" } ], "type": { @@ -3408,63 +4612,77 @@ }, { "type": "reference", - "name": "WebSocketLike" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLike" + }, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" } ] }, "defaultValue": "null" }, { - "id": 398, + "id": 400, "name": "decode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 + "line": 104, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L104" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 397, + "id": 399, "name": "encode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 + "line": 103, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L103" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 379, + "id": 380, "name": "endPoint", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 + "line": 90, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L90" } ], "type": { @@ -3474,101 +4692,159 @@ "defaultValue": "''" }, { - "id": 409, + "id": 411, "name": "fetch", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 + "line": 120, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L120" } ], "type": { "type": "reflection", "declaration": { - "id": 410, + "id": 412, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 28708, + "character": 17 + }, + { + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], "signatures": [ { - "id": 411, + "id": 413, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 28708, + "character": 17 + } + ], "parameters": [ { - "id": 412, + "id": 414, "name": "input", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInfo" + }, + "name": "RequestInfo", + "package": "typescript" }, { "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } ] } }, { - "id": 413, + "id": 415, "name": "init", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } }, { - "id": 414, + "id": 416, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], "parameters": [ { - "id": 415, + "id": 417, "name": "input", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "union", @@ -3579,48 +4855,63 @@ }, { "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Request" + }, + "name": "Request", + "package": "typescript" }, { "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } ] } }, { - "id": 416, + "id": 418, "name": "init", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -3628,85 +4919,107 @@ } }, { - "id": 381, + "id": 382, "name": "headers", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 + "line": 92, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" } ], "type": { "type": "reflection", "declaration": { - "id": 382, + "id": 383, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 92, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" } - } + ], + "indexSignatures": [ + { + "id": 384, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 92, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" + } + ], + "parameters": [ + { + "id": 385, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } }, "defaultValue": "DEFAULT_HEADERS" }, { - "id": 391, + "id": 392, "name": "heartbeatIntervalMs", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L96" } ], "type": { "type": "intrinsic", "name": "number" }, - "defaultValue": "30000" + "defaultValue": "25000" }, { - "id": 392, + "id": 393, "name": "heartbeatTimer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 + "line": 97, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L97" } ], "type": { @@ -3718,25 +5031,30 @@ }, { "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", + "target": { + "sourceFileName": "node_modules/@types/node/timers.d.ts", + "qualifiedName": "__global.NodeJS.Timeout" + }, + "name": "Timeout", "package": "@types/node", - "name": "Timeout" + "qualifiedName": "__global.NodeJS.Timeout" } ] }, "defaultValue": "undefined" }, { - "id": 380, + "id": 381, "name": "httpEndpoint", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 + "line": 91, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L91" } ], "type": { @@ -3746,87 +5064,138 @@ "defaultValue": "''" }, { - "id": 396, + "id": 397, "name": "logger", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 + "line": 101, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L101" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" }, "defaultValue": "noop" }, { - "id": 385, - "name": "params", + "id": 398, + "name": "logLevel", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 + "line": 102, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L102" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "LOG_LEVEL" + }, + "name": "LOG_LEVEL", + "package": "@supabase/realtime-js" + } + }, + { + "id": 386, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" } ], "type": { "type": "reflection", "declaration": { - "id": 386, + "id": 387, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" } - } + ], + "indexSignatures": [ + { + "id": 388, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" + } + ], + "parameters": [ + { + "id": 389, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } }, "defaultValue": "{}" }, { - "id": 393, + "id": 394, "name": "pendingHeartbeatRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 + "line": 98, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L98" } ], "type": { @@ -3845,54 +5214,66 @@ "defaultValue": "null" }, { - "id": 399, + "id": 401, "name": "reconnectAfterMs", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L105" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 396, + "name": "reconnectTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 100, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L100" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 395, + "name": "ref", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L99" } ], "type": { @@ -3902,159 +5283,187 @@ "defaultValue": "0" }, { - "id": 401, + "id": 403, "name": "sendBuffer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 + "line": 107, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L107" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, "defaultValue": "[]" }, { - "id": 402, + "id": 404, "name": "serializer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 + "line": 108, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L108" } ], "type": { "type": "reference", - "name": "default" + "target": { + "sourceFileName": "src/lib/serializer.ts", + "qualifiedName": "default" + }, + "name": "Serializer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" }, "defaultValue": "..." }, { - "id": 403, + "id": 405, "name": "stateChangeCallbacks", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 + "line": 109, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L109" } ], "type": { "type": "reflection", "declaration": { - "id": 404, + "id": 406, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 406, + "id": 408, "name": "close", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 + "line": 111, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L111" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + } + }, + { + "id": 409, + "name": "error", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 112, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L112" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + } + }, + { + "id": 410, + "name": "message", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 113, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L113" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } }, { "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, "name": "open", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 + "line": 110, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L110" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } } @@ -4062,8 +5471,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] + "children": [408, 409, 410, 407] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 109, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L109" } ] } @@ -4071,16 +5487,17 @@ "defaultValue": "..." }, { - "id": 389, + "id": 390, "name": "timeout", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 + "line": 94, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L94" } ], "type": { @@ -4090,16 +5507,17 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 390, + "id": 391, "name": "transport", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 + "line": 95, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L95" } ], "type": { @@ -4111,24 +5529,30 @@ }, { "type": "reference", - "name": "WebSocketLikeConstructor" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "name": "WebSocketLikeConstructor", + "package": "@supabase/realtime-js" } ] } }, { - "id": 420, + "id": 422, "name": "worker", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 + "line": 122, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L122" } ], "type": { @@ -4137,40 +5561,45 @@ } }, { - "id": 422, + "id": 424, "name": "workerRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 + "line": 124, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L124" } ], "type": { "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Worker" + }, + "name": "Worker", + "package": "typescript" } }, { - "id": 421, + "id": 423, "name": "workerUrl", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 + "line": 123, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L123" } ], "type": { @@ -4179,82 +5608,40 @@ } }, { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, + "id": 449, "name": "channel", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L331" } ], "signatures": [ { - "id": 448, + "id": 450, "name": "channel", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L331" + } + ], "parameters": [ { - "id": 449, + "id": 451, "name": "topic", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -4262,50 +5649,67 @@ } }, { - "id": 450, + "id": 452, "name": "params", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions" + "target": 359, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" }, "defaultValue": "..." } ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 423, + "id": 425, "name": "connect", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 + "line": 202, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L202" } ], "signatures": [ { - "id": 424, + "id": 426, "name": "connect", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Connects the socket, unless already connected." + "summary": [ + { + "kind": "text", + "text": "Connects the socket, unless already connected." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 202, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L202" + } + ], "type": { "type": "intrinsic", "name": "void" @@ -4314,69 +5718,107 @@ ] }, { - "id": 443, + "id": 445, "name": "connectionState", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 + "line": 311, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L311" } ], "signatures": [ { - "id": 444, + "id": 446, "name": "connectionState", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the current state of the socket." + "summary": [ + { + "kind": "text", + "text": "Returns the current state of the socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 311, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L311" + } + ], "type": { "type": "reference", - "name": "CONNECTION_STATE" + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CONNECTION_STATE" + }, + "name": "CONNECTION_STATE", + "package": "@supabase/realtime-js" } } ] }, { - "id": 427, + "id": 429, "name": "disconnect", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 + "line": 252, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L252" } ], "signatures": [ { - "id": 428, + "id": 430, "name": "disconnect", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Disconnects the socket." + "summary": [ + { + "kind": "text", + "text": "Disconnects the socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 252, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L252" + } + ], "parameters": [ { - "id": 429, + "id": 431, "name": "code", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "A numeric status code to send on disconnect." + "summary": [ + { + "kind": "text", + "text": "A numeric status code to send on disconnect." + } + ] }, "type": { "type": "intrinsic", @@ -4384,15 +5826,20 @@ } }, { - "id": 430, + "id": 432, "name": "reason", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "A custom reason for the disconnect.\n" + "summary": [ + { + "kind": "text", + "text": "A custom reason for the disconnect." + } + ] }, "type": { "type": "intrinsic", @@ -4408,29 +5855,53 @@ ] }, { - "id": 425, + "id": 427, "name": "endpointURL", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 + "line": 239, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L239" } ], "signatures": [ { - "id": 426, + "id": 428, "name": "endpointURL", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" + "summary": [ + { + "kind": "text", + "text": "Returns the URL of the websocket." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "string The URL of the websocket." + } + ] + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 239, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L239" + } + ], "type": { "type": "intrinsic", "name": "string" @@ -4439,28 +5910,42 @@ ] }, { - "id": 459, + "id": 461, "name": "flushSendBuffer", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 + "line": 421, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L421" } ], "signatures": [ { - "id": 460, + "id": 462, "name": "flushSendBuffer", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Flushes send buffer" + "summary": [ + { + "kind": "text", + "text": "Flushes send buffer" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 421, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L421" + } + ], "type": { "type": "intrinsic", "name": "void" @@ -4469,62 +5954,100 @@ ] }, { - "id": 431, + "id": 433, "name": "getChannels", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 + "line": 270, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L270" } ], "signatures": [ { - "id": 432, + "id": 434, "name": "getChannels", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns all created channels" + "summary": [ + { + "kind": "text", + "text": "Returns all created channels" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 270, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L270" + } + ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } } ] }, { - "id": 445, + "id": 447, "name": "isConnected", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 + "line": 327, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L327" } ], "signatures": [ { - "id": 446, + "id": 448, "name": "isConnected", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns `true` is the connection is open." + "summary": [ + { + "kind": "text", + "text": "Returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " is the connection is open." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 327, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L327" + } + ], "type": { "type": "intrinsic", "name": "boolean" @@ -4533,57 +6056,78 @@ ] }, { - "id": 438, + "id": 440, "name": "log", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 + "line": 304, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L304" } ], "signatures": [ { - "id": 439, + "id": 441, "name": "log", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" + "summary": [ + { + "kind": "text", + "text": "Logs the message.\n\nFor customized logging, " + }, + { + "kind": "code", + "text": "`this.logger`" + }, + { + "kind": "text", + "text": " can be overridden." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 304, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L304" + } + ], "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 442, + "name": "kind", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "msg", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 444, "name": "data", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, @@ -4601,40 +6145,54 @@ ] }, { - "id": 451, + "id": 453, "name": "push", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 + "line": 345, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L345" } ], "signatures": [ { - "id": 452, + "id": 454, "name": "push", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" + "summary": [ + { + "kind": "text", + "text": "Push out a message if the socket is connected.\n\nIf the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 345, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L345" + } + ], "parameters": [ { - "id": 453, + "id": 455, "name": "data", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 536, - "name": "RealtimeMessage" + "target": 540, + "name": "RealtimeMessage", + "package": "@supabase/realtime-js" } } ], @@ -4646,174 +6204,260 @@ ] }, { - "id": 436, + "id": 438, "name": "removeAllChannels", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 + "line": 291, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L291" } ], "signatures": [ { - "id": 437, + "id": 439, "name": "removeAllChannels", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes all channels" + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes all channels" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 291, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L291" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" + "target": 617, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" } } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 433, + "id": 435, "name": "removeChannel", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 + "line": 278, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L278" } ], "signatures": [ { - "id": 434, + "id": 436, "name": "removeChannel", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes a single channel" + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes a single channel" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 278, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L278" + } + ], "parameters": [ { - "id": 435, + "id": 437, "name": "channel", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A RealtimeChannel instance\n" + "summary": [ + { + "kind": "text", + "text": "A RealtimeChannel instance" + } + ] }, "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" + "target": 617, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 457, + "id": 459, "name": "sendHeartbeat", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 + "line": 395, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L395" } ], "signatures": [ { - "id": 458, + "id": 460, "name": "sendHeartbeat", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." + "summary": [ + { + "kind": "text", + "text": "Sends a heartbeat message if the socket is connected." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 395, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L395" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 454, + "id": 456, "name": "setAuth", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 + "line": 369, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L369" } ], "signatures": [ { - "id": 455, + "id": 457, "name": "setAuth", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.\n\nIf param is null it will use the " + }, + { + "kind": "code", + "text": "`accessToken`" + }, + { + "kind": "text", + "text": " callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 369, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L369" + } + ], "parameters": [ { - "id": 456, + "id": 458, "name": "token", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string to override the token set on the client.\n" + "summary": [ + { + "kind": "text", + "text": "A JWT string to override the token set on the client." + } + ] }, "type": { "type": "union", @@ -4833,15 +6477,18 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -4850,100 +6497,133 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [372] + "children": [373] }, { "title": "Properties", - "kind": 1024, "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, 399, - 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 + 419, 377, 378, 379, 402, 400, 399, 380, 411, 382, 392, 393, 381, 397, 398, 386, 394, + 401, 396, 395, 403, 404, 405, 390, 391, 422, 424, 423 ] }, { "title": "Methods", - "kind": 2048, - "children": [510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454] + "children": [449, 425, 445, 429, 427, 461, 433, 447, 440, 453, 438, 435, 459, 456] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 + "line": 86, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L86" } ] }, { "id": 1, "name": "RealtimePresence", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "children": [ { "id": 36, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" } ], "signatures": [ { "id": 37, - "name": "new RealtimePresence", + "name": "RealtimePresence", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Initializes the Presence." + "summary": [ + { + "kind": "text", + "text": "Initializes the Presence." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 84, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" + } + ], "parameters": [ { "id": 38, "name": "channel", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The RealtimeChannel" + "summary": [ + { + "kind": "text", + "text": "The RealtimeChannel" + } + ] }, "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { "id": 39, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" + "summary": [ + { + "kind": "text", + "text": "The options,\n for example " + }, + { + "kind": "code", + "text": "`{events: {state: 'state', diff: 'diff'}}`" + } + ] }, "type": { "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOpts" + }, + "name": "PresenceOpts", + "package": "@types/phoenix" } } ], "type": { "type": "reference", - "id": 1, - "name": "default" + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] @@ -4951,14 +6631,15 @@ { "id": 44, "name": "caller", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 67, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L67" } ], "type": { @@ -4966,88 +6647,125 @@ "declaration": { "id": 45, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { "id": 46, "name": "onJoin", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 68, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L68" } ], "type": { "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnJoinCallback" + }, + "name": "PresenceOnJoinCallback", + "package": "@types/phoenix" } }, { "id": 47, "name": "onLeave", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 69, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L69" } ], "type": { "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnLeaveCallback" + }, + "name": "PresenceOnLeaveCallback", + "package": "@types/phoenix" } }, { "id": 48, "name": "onSync", - "kind": 2048, - "kindString": "Method", + "variant": "declaration", + "kind": 1024, "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 70, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 70, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" + } + ], + "signatures": [ + { + "id": 50, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 70, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, + "children": [46, 47, 48] + } + ], + "sources": [ { - "title": "Methods", - "kind": 2048, - "children": [48] + "fileName": "src/RealtimePresence.ts", + "line": 67, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L67" } ] } @@ -5055,30 +6773,49 @@ "defaultValue": "..." }, { - "id": 50, + "id": 51, "name": "channel", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isPublic": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The RealtimeChannel" + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 84, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" + } + ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { "id": 43, "name": "joinRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L66" } ], "type": { @@ -5099,21 +6836,27 @@ { "id": 42, "name": "pendingDiffs", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 65, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L65" } ], "type": { "type": "array", "elementType": { "type": "reference", - "name": "RawPresenceDiff" + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RawPresenceDiff" + }, + "name": "RawPresenceDiff", + "package": "@supabase/realtime-js" } }, "defaultValue": "[]" @@ -5121,32 +6864,34 @@ { "id": 40, "name": "state", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L64" } ], "type": { "type": "reference", - "id": 604, + "target": 608, "typeArguments": [ { "type": "reflection", "declaration": { "id": 41, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } ], - "name": "RealtimePresenceState" + "name": "RealtimePresenceState", + "package": "@supabase/realtime-js" }, "defaultValue": "{}" } @@ -5154,99 +6899,106 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [36] }, { "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [44, 51, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L63" } ] }, { - "id": 358, + "id": 359, "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 359, + "id": 360, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 361, "name": "config", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L17" } ], "type": { "type": "reflection", "declaration": { - "id": 361, + "id": 362, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 362, + "id": 363, "name": "broadcast", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + "summary": [ + { + "kind": "text", + "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { "type": "reflection", "declaration": { - "id": 363, + "id": 364, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 366, "name": "ack", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -5254,7 +7006,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { @@ -5263,10 +7016,10 @@ } }, { - "id": 364, + "id": 365, "name": "self", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -5274,7 +7027,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { @@ -5286,52 +7040,58 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [365, 364] + "children": [366, 365] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ] } } }, { - "id": 366, + "id": 367, "name": "presence", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "key option is used to track presence payload across clients" + "summary": [ + { + "kind": "text", + "text": "key option is used to track presence payload across clients" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ], "type": { "type": "reflection", "declaration": { - "id": 367, + "id": 368, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 369, "name": "key", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -5339,7 +7099,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ], "type": { @@ -5351,36 +7112,42 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [368] + "children": [369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ] } } }, { - "id": 369, + "id": 370, "name": "private", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + "summary": [ + { + "kind": "text", + "text": "defines if the channel is private or not and if RLS policies will be used to check data" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 30, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L30" } ], "type": { @@ -5392,15 +7159,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] + "children": [363, 367, 370] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 17, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L17" } ] } @@ -5410,31 +7177,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [360] + "children": [361] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L16" } ] } } }, { - "id": 370, + "id": 371, "name": "RealtimeChannelSendResponse", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 88, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L88" } ], "type": { @@ -5456,317 +7224,257 @@ } }, { - "id": 513, + "id": 515, "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 + "line": 60, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L60" } ], "type": { "type": "reflection", "declaration": { - "id": 514, + "id": 516, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 520, - "name": "decode", + "id": 537, + "name": "accessToken", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 + "line": 76, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L76" } ], "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 + "type": "reflection", + "declaration": { + "id": 538, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 76, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L76" + } + ], + "signatures": [ + { + "id": 539, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" } }, { "id": 522, - "name": "headers", + "name": "decode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 + "line": 66, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L66" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { "id": 521, - "name": "reconnectAfterMs", + "name": "encode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 + "line": 65, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L65" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 516, - "name": "timeout", + "id": 534, + "name": "fetch", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 + "line": 73, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L73" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "Fetch" + }, + "name": "Fetch", + "package": "@supabase/realtime-js" + } + }, + { + "id": 524, + "name": "headers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 525, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "indexSignatures": [ + { + "id": 526, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "parameters": [ + { + "id": 527, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + }, + { + "id": 519, + "name": "heartbeatIntervalMs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 63, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L63" } ], "type": { @@ -5775,38 +7483,239 @@ } }, { - "id": 515, - "name": "transport", + "id": 532, + "name": "log_level", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 + "line": 71, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L71" } ], "type": { "type": "reference", - "name": "WebSocketLikeConstructor" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "LogLevel" + }, + "name": "LogLevel", + "package": "@supabase/realtime-js" } }, { - "id": 532, - "name": "worker", + "id": 520, + "name": "logger", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 + "line": 64, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L64" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 533, + "name": "logLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L72" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "LogLevel" + }, + "name": "LogLevel", + "package": "@supabase/realtime-js" + } + }, + { + "id": 528, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 529, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "indexSignatures": [ + { + "id": 530, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "parameters": [ + { + "id": 531, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + }, + { + "id": 523, + "name": "reconnectAfterMs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L67" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 518, + "name": "timeout", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 62, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L62" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 517, + "name": "transport", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 61, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L61" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "name": "WebSocketLikeConstructor", + "package": "@supabase/realtime-js" + } + }, + { + "id": 535, + "name": "worker", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L74" } ], "type": { @@ -5815,18 +7724,81 @@ } }, { - "id": 533, + "id": 536, "name": "workerUrl", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 + "line": 75, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L75" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 537, 522, 521, 534, 524, 519, 532, 520, 533, 528, 523, 518, 517, 535, 536 + ] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 60, + "character": 36, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L60" + } + ] + } + } + }, + { + "id": 540, + "name": "RealtimeMessage", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 32, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L32" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 541, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 543, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 34, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L34" } ], "type": { @@ -5835,107 +7807,57 @@ } }, { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 546, + "name": "join_ref", + "variant": "declaration", + "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 + "line": 37, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L37" } ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533] + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - }, - { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", + "id": 544, + "name": "payload", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 + "line": 35, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L35" + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 545, + "name": "ref", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 36, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L36" } ], "type": { @@ -5945,71 +7867,16 @@ }, { "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, "name": "topic", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 + "line": 33, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L33" } ], "type": { @@ -6021,49 +7888,51 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] + "children": [543, 546, 544, 545, 542] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 + "line": 32, + "character": 30, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L32" } ] } } }, { - "id": 543, + "id": 547, "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 67, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L67" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 549, + "id": 553, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" + "target": 623, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "package": "@supabase/realtime-js" }, "" ] @@ -6074,50 +7943,64 @@ "type": { "type": "reflection", "declaration": { - "id": 544, + "id": 548, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 545, + "id": 549, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of database change to listen to." + "summary": [ + { + "kind": "text", + "text": "The type of database change to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 73, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L73" } ], "type": { "type": "reference", - "id": 549, - "name": "T" + "target": 553, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 548, + "id": 552, "name": "filter", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Receive database changes when filter is matched." + "summary": [ + { + "kind": "text", + "text": "Receive database changes when filter is matched." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 85, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L85" } ], "type": { @@ -6126,19 +8009,25 @@ } }, { - "id": 546, + "id": 550, "name": "schema", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The database schema to listen to." + "summary": [ + { + "kind": "text", + "text": "The database schema to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 77, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L77" } ], "type": { @@ -6147,21 +8036,27 @@ } }, { - "id": 547, + "id": 551, "name": "table", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "The database table to listen to." + "summary": [ + { + "kind": "text", + "text": "The database table to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 81, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L81" } ], "type": { @@ -6173,78 +8068,91 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] + "children": [549, 552, 550, 551] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 69, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L69" } ] } } }, { - "id": 550, + "id": 554, "name": "RealtimePostgresChangesPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 554, + "id": 555, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 551, + "id": 556, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, - "character": 53 + "character": 53, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } ], - "indexSignature": { - "id": 552, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 553, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 557, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 62, + "character": 55, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } + ], + "parameters": [ + { + "id": 558, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -6254,101 +8162,123 @@ "types": [ { "type": "reference", - "id": 555, + "target": 559, "typeArguments": [ { "type": "reference", - "id": 554, - "name": "T" + "target": 555, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "name": "RealtimePostgresInsertPayload" + "name": "RealtimePostgresInsertPayload", + "package": "@supabase/realtime-js" }, { "type": "reference", - "id": 565, + "target": 569, "typeArguments": [ { "type": "reference", - "id": 554, - "name": "T" + "target": 555, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "name": "RealtimePostgresUpdatePayload" + "name": "RealtimePostgresUpdatePayload", + "package": "@supabase/realtime-js" }, { "type": "reference", - "id": 574, + "target": 578, "typeArguments": [ { "type": "reference", - "id": 554, - "name": "T" + "target": 555, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "name": "RealtimePostgresDeletePayload" + "name": "RealtimePostgresDeletePayload", + "package": "@supabase/realtime-js" } ] } }, { - "id": 574, + "id": 578, "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 55, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 583, + "id": 584, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 585, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 55, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } ], - "indexSignature": { - "id": 581, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 582, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 586, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 55, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } + ], + "parameters": [ + { + "id": 587, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -6358,39 +8288,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 575, + "id": 579, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 576, + "id": 580, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 57, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L57" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 623, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + "target": 627, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", + "package": "@supabase/realtime-js" }, "" ] @@ -6398,76 +8335,84 @@ } }, { - "id": 577, + "id": 581, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 58, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L58" } ], "type": { "type": "reflection", "declaration": { - "id": 578, + "id": 582, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 58, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L58" } ] } } }, { - "id": 579, + "id": 583, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 59, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L59" } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, "typeArguments": [ { "type": "reference", - "id": 583, - "name": "T" + "target": 584, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "name": "Partial", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [576, 577, 579] + "children": [580, 581, 583] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 56, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L56" } ] } @@ -6476,63 +8421,76 @@ } }, { - "id": 555, + "id": 559, "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 41, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 564, + "id": 565, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 561, + "id": 566, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 41, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } ], - "indexSignature": { - "id": 562, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 563, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 567, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 41, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } + ], + "parameters": [ + { + "id": 568, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -6542,39 +8500,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 556, + "id": 560, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 557, + "id": 561, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L43" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 621, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + "target": 625, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", + "package": "@supabase/realtime-js" }, "" ] @@ -6582,50 +8547,55 @@ } }, { - "id": 558, + "id": 562, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L44" } ], "type": { "type": "reference", - "id": 564, - "name": "T" + "target": 565, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 559, + "id": 563, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L45" } ], "type": { "type": "reflection", "declaration": { - "id": 560, + "id": 564, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L45" } ] } @@ -6635,15 +8605,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [557, 558, 559] + "children": [561, 562, 563] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 42, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L42" } ] } @@ -6652,63 +8622,76 @@ } }, { - "id": 565, + "id": 569, "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 48, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 573, + "id": 574, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 570, + "id": 575, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 48, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } ], - "indexSignature": { - "id": 571, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 572, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 576, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } + ], + "parameters": [ + { + "id": 577, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -6718,39 +8701,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 566, + "id": 570, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 567, + "id": 571, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 50, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L50" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 622, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + "target": 626, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", + "package": "@supabase/realtime-js" }, "" ] @@ -6758,64 +8748,73 @@ } }, { - "id": 568, + "id": 572, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 51, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L51" } ], "type": { "type": "reference", - "id": 573, - "name": "T" + "target": 574, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 569, + "id": 573, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 52, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L52" } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, "typeArguments": [ { "type": "reference", - "id": 573, - "name": "T" + "target": 574, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "name": "Partial", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [567, 568, 569] + "children": [571, 572, 573] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 49, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L49" } ] } @@ -6824,460 +8823,74 @@ } }, { - "id": 584, + "id": 588, "name": "RealtimePresenceJoinPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 593, + "id": 594, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 590, + "id": 595, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, - "character": 50 + "character": 50, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } ], - "indexSignature": { - "id": 591, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 592, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 596, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 21, + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } + ], + "parameters": [ + { + "id": 597, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 588, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 593, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 586, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 626, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "" - ] - ] - } - }, - { - "id": 587, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "newPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 593, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [588, 586, 587, 589] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 21, - "character": 76 - } - ] - } - } - }, - { - "id": 594, - "name": "RealtimePresenceLeavePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 603, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 600, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 51 - } - ], - "indexSignature": { - "id": 601, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 602, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 598, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 603, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 596, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 627, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "" - ] - ] - } - }, - { - "id": 597, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 599, - "name": "leftPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 603, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [598, 596, 597, 599] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 77 - } - ] - } - } - }, - { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 } ] } @@ -7287,65 +8900,549 @@ "type": { "type": "reflection", "declaration": { - "id": 605, + "id": 589, "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 592, + "name": "currentPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 24, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L24" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 594, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + }, + { + "id": 590, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L22" + } + ], + "type": { + "type": "templateLiteral", + "head": "", + "tail": [ + [ + { + "type": "reference", + "target": 630, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", + "package": "@supabase/realtime-js" + }, + "" + ] + ] + } + }, + { + "id": 591, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L23" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 593, + "name": "newPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 25, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L25" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 594, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [592, 590, 591, 593] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 21, + "character": 76, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" + } + ] + } + } + }, + { + "id": 598, + "name": "RealtimePresenceLeavePayload", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "typeParameters": [ + { + "id": 604, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 605, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 51, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "indexSignatures": [ + { + "id": 606, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 53, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "parameters": [ + { + "id": 607, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 599, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 602, + "name": "currentPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 31, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L31" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 604, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + }, + { + "id": 600, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 29, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L29" + } + ], + "type": { + "type": "templateLiteral", + "head": "", + "tail": [ + [ + { + "type": "reference", + "target": 631, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", + "package": "@supabase/realtime-js" + }, + "" + ] + ] + } + }, + { + "id": 601, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 30, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L30" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 603, + "name": "leftPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 32, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L32" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 604, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [602, 600, 601, 603] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 77, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ] + } + } + }, + { + "id": 608, + "name": "RealtimePresenceState", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "typeParameters": [ + { + "id": 612, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 613, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 44, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "indexSignatures": [ + { + "id": 614, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 46, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "parameters": [ + { + "id": 615, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 616, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 69, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 609, + "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, - "character": 75 + "character": 75, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" } ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 610, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L18" + } + ], + "parameters": [ + { + "id": 611, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 612, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" } } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } } - } + ] } } }, { - "id": 613, + "id": 617, "name": "RealtimeRemoveChannelResponse", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 54, - "character": 12 + "line": 40, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L40" } ], "type": { @@ -7367,10 +9464,10 @@ } }, { - "id": 633, + "id": 637, "name": "REALTIME_CHANNEL_STATES", + "variant": "declaration", "kind": 32, - "kindString": "Variable", "flags": { "isConst": true }, @@ -7378,14 +9475,21 @@ { "fileName": "src/RealtimeChannel.ts", "line": 111, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L111" } ], "type": { "type": "query", "queryType": { "type": "reference", - "name": "CHANNEL_STATES" + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CHANNEL_STATES" + }, + "name": "CHANNEL_STATES", + "package": "@supabase/realtime-js", + "preferValues": true } }, "defaultValue": "CHANNEL_STATES" @@ -7394,30 +9498,1904 @@ "groups": [ { "title": "Enumerations", - "kind": 8, - "children": [614, 619, 624, 628] + "children": [618, 623, 628, 632] }, { "title": "Classes", - "kind": 128, - "children": [64, 371, 1] + "children": [65, 372, 1] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [358, 370, 513, 536, 543, 550, 574, 555, 565, 584, 594, 604, 613] + "children": [359, 371, 515, 540, 547, 554, 578, 559, 569, 588, 598, 608, 617] }, { "title": "Variables", - "kind": 32, - "children": [633] + "children": [637] } ], - "sources": [ + "packageName": "@supabase/realtime-js", + "readme": [ { - "fileName": "src/index.ts", - "line": 1, - "character": 0 + "kind": "text", + "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" + }, + { + "kind": "code", + "text": "```bash\nnpm install @supabase/realtime-js\n```" + }, + { + "kind": "text", + "text": "\n\n## Creating a Channel\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { RealtimeClient } from '@supabase/realtime-js'\n\nconst client = new RealtimeClient(REALTIME_URL, {\n params: {\n apikey: API_KEY\n },\n})\n\nconst channel = client.channel('test-channel', {})\n\nchannel.subscribe((status, err) => {\n if (status === 'SUBSCRIBED') {\n console.log('Connected!')\n }\n\n if (status === 'CHANNEL_ERROR') {\n console.log(`There was an error subscribing to channel: ${err.message}`)\n }\n\n if (status === 'TIMED_OUT') {\n console.log('Realtime server did not respond in time.')\n }\n\n if (status === 'CLOSED') {\n console.log('Realtime channel was unexpectedly closed.')\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n### Notes:\n\n- " + }, + { + "kind": "code", + "text": "`REALTIME_URL`" + }, + { + "kind": "text", + "text": " is " + }, + { + "kind": "code", + "text": "`'ws://localhost:4000/socket'`" + }, + { + "kind": "text", + "text": " when developing locally and " + }, + { + "kind": "code", + "text": "`'wss://.supabase.co/realtime/v1'`" + }, + { + "kind": "text", + "text": " when connecting to your Supabase project.\n- " + }, + { + "kind": "code", + "text": "`API_KEY`" + }, + { + "kind": "text", + "text": " is a JWT whose claims must contain " + }, + { + "kind": "code", + "text": "`exp`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " (existing database role).\n- Channel name can be any " + }, + { + "kind": "code", + "text": "`string`" + }, + { + "kind": "text", + "text": ".\n\n## Broadcast\n\nYour client can send and receive messages based on the " + }, + { + "kind": "code", + "text": "`event`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n### Notes:\n\n- Setting " + }, + { + "kind": "code", + "text": "`ack`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the " + }, + { + "kind": "code", + "text": "`channel.send`" + }, + { + "kind": "text", + "text": " promise will resolve once server replies with acknowledgement that it received the broadcast message request.\n- Setting " + }, + { + "kind": "code", + "text": "`self`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the client will receive the broadcast message it sent out.\n- Setting " + }, + { + "kind": "code", + "text": "`private`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the client will use RLS to determine if the user can connect or not to a given channel.\n\n## Presence\n\nYour client can track and sync state that's stored in the channel.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel(\n 'presence-test',\n {\n config: {\n presence: {\n key: ''\n }\n }\n }\n)\n\nchannel.on('presence', { event: 'sync' }, () => {\n console.log('Online users: ', channel.presenceState())\n})\n\nchannel.on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('New users have joined: ', newPresences)\n})\n\nchannel.on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Users have left: ', leftPresences)\n})\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n const status = await channel.track({ 'user_id': 1 })\n console.log(status)\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n## Postgres CDC\n\nReceive database changes on the client.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('db-changes')\n\nchannel.on('postgres_changes', { event: '*', schema: 'public' }, (payload) => {\n console.log('All changes in public schema: ', payload)\n})\n\nchannel.on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'messages' }, (payload) => {\n console.log('All inserts in messages table: ', payload)\n})\n\nchannel.on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' }, (payload) => {\n console.log('All updates on users table when username is Realtime: ', payload)\n})\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n console.log('Ready to receive database changes!')\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n## Get All Channels\n\nYou can see all the channels that your client has instantiatied.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nclient.getChannels()\n```" + }, + { + "kind": "text", + "text": "\n\n## Cleanup\n\nIt is highly recommended that you clean up your channels after you're done with them.\n\n- Remove a single channel\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('some-channel-to-remove')\n\nchannel.subscribe()\n\nclient.removeChannel(channel)\n```" + }, + { + "kind": "text", + "text": "\n\n- Remove all channels\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel1 = client.channel('a-channel-to-remove')\nconst channel2 = client.channel('another-channel-to-remove')\n\nchannel1.subscribe()\nchannel2.subscribe()\n\nclient.removeAllChannels()\n```" + }, + { + "kind": "text", + "text": "\n\n## Credits\n\nThis repo draws heavily from [phoenix-js](https://github.com/phoenixframework/phoenix/tree/master/assets/js/phoenix).\n\n## License\n\nMIT." } - ] + ], + "symbolIdMap": { + "0": { + "sourceFileName": "src/index.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default" + }, + "36": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.__constructor" + }, + "37": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default" + }, + "38": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "channel" + }, + "39": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "opts" + }, + "40": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.state" + }, + "41": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "42": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.pendingDiffs" + }, + "43": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.joinRef" + }, + "44": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.caller" + }, + "45": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "46": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onJoin" + }, + "47": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onLeave" + }, + "48": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onSync" + }, + "49": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "50": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "51": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.channel" + }, + "65": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default" + }, + "76": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.__constructor" + }, + "77": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default" + }, + "78": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "topic" + }, + "79": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "params" + }, + "80": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "socket" + }, + "81": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.bindings" + }, + "82": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "83": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "85": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "86": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "87": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.filter" + }, + "88": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "89": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "91": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.callback" + }, + "92": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.id" + }, + "93": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.timeout" + }, + "94": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.state" + }, + "95": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.joinedOnce" + }, + "96": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.joinPush" + }, + "97": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.rejoinTimer" + }, + "98": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.pushBuffer" + }, + "99": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presence" + }, + "100": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.broadcastEndpointURL" + }, + "101": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subTopic" + }, + "102": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.private" + }, + "103": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.topic" + }, + "104": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.params" + }, + "105": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.socket" + }, + "106": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subscribe" + }, + "107": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subscribe" + }, + "108": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "109": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "110": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "111": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "status" + }, + "112": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "err" + }, + "113": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "timeout" + }, + "114": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presenceState" + }, + "115": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presenceState" + }, + "116": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "117": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "118": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "120": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "121": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.track" + }, + "122": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.track" + }, + "123": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "124": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "125": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "127": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "128": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "129": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "131": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.untrack" + }, + "132": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.untrack" + }, + "133": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "134": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "135": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "137": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "138": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "139": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "140": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "141": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "142": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "143": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "144": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "145": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "146": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "147": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "148": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "149": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "151": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "152": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "153": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "154": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "155": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "156": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "157": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "158": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "159": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "160": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "161": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "162": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "164": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "165": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "166": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "167": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "168": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "169": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "170": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "171": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "172": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "173": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "174": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "175": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "177": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "178": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "179": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "180": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "181": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "182": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "183": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "184": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "185": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "186": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "188": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "189": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "190": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "191": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "192": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "193": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "194": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "195": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "196": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "197": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "199": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "200": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "201": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "202": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "203": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "204": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "205": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "206": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "207": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "208": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "210": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "211": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "212": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "213": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "214": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "215": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "216": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "217": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "218": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "219": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "220": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "221": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "222": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "223": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "224": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "225": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "226": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "227": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "228": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "230": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "231": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "232": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "233": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "235": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "236": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "237": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "238": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "239": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "240": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "241": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "242": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "243": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "244": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "245": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "246": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.payload" + }, + "247": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "248": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "249": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "250": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "252": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "253": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "254": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "255": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "256": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "257": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "258": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "259": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.send" + }, + "260": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.send" + }, + "261": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "args" + }, + "262": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "263": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "264": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "265": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.payload" + }, + "266": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "268": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "269": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "270": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "272": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.updateJoinPayload" + }, + "273": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.updateJoinPayload" + }, + "274": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "275": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "276": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "278": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.unsubscribe" + }, + "279": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.unsubscribe" + }, + "280": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "timeout" + }, + "359": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimeChannelOptions" + }, + "360": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "361": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.config" + }, + "362": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "363": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.broadcast" + }, + "364": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "365": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.self" + }, + "366": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.ack" + }, + "367": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.presence" + }, + "368": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "369": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.key" + }, + "370": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.private" + }, + "371": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimeChannelSendResponse" + }, + "372": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default" + }, + "373": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.__constructor" + }, + "374": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default" + }, + "375": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "endPoint" + }, + "376": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "options" + }, + "377": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.accessTokenValue" + }, + "378": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.apiKey" + }, + "379": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channels" + }, + "380": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endPoint" + }, + "381": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.httpEndpoint" + }, + "382": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.headers" + }, + "383": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "384": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "386": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.params" + }, + "387": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "388": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "390": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.timeout" + }, + "391": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.transport" + }, + "392": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.heartbeatIntervalMs" + }, + "393": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.heartbeatTimer" + }, + "394": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.pendingHeartbeatRef" + }, + "395": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.ref" + }, + "396": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.reconnectTimer" + }, + "397": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.logger" + }, + "398": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.logLevel" + }, + "399": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.encode" + }, + "400": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.decode" + }, + "401": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.reconnectAfterMs" + }, + "402": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.conn" + }, + "403": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendBuffer" + }, + "404": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.serializer" + }, + "405": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.stateChangeCallbacks" + }, + "406": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "407": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.open" + }, + "408": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.close" + }, + "409": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.error" + }, + "410": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.message" + }, + "411": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.fetch" + }, + "412": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "fetch" + }, + "413": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "fetch" + }, + "414": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "input" + }, + "415": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "init" + }, + "416": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "fetch" + }, + "417": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "input" + }, + "418": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "init" + }, + "419": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.accessToken" + }, + "420": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "421": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "422": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.worker" + }, + "423": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.workerUrl" + }, + "424": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.workerRef" + }, + "425": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connect" + }, + "426": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connect" + }, + "427": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endpointURL" + }, + "428": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endpointURL" + }, + "429": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.disconnect" + }, + "430": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.disconnect" + }, + "431": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "code" + }, + "432": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "reason" + }, + "433": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.getChannels" + }, + "434": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.getChannels" + }, + "435": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeChannel" + }, + "436": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeChannel" + }, + "437": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "channel" + }, + "438": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeAllChannels" + }, + "439": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeAllChannels" + }, + "440": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.log" + }, + "441": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.log" + }, + "442": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "kind" + }, + "443": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "msg" + }, + "444": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "data" + }, + "445": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connectionState" + }, + "446": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connectionState" + }, + "447": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnected" + }, + "448": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnected" + }, + "449": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channel" + }, + "450": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channel" + }, + "451": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "topic" + }, + "452": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "params" + }, + "453": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.push" + }, + "454": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.push" + }, + "455": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "data" + }, + "456": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.setAuth" + }, + "457": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.setAuth" + }, + "458": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "token" + }, + "459": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendHeartbeat" + }, + "460": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendHeartbeat" + }, + "461": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.flushSendBuffer" + }, + "462": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.flushSendBuffer" + }, + "515": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeClientOptions" + }, + "516": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "517": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.transport" + }, + "518": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.timeout" + }, + "519": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.heartbeatIntervalMs" + }, + "520": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.logger" + }, + "521": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.encode" + }, + "522": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.decode" + }, + "523": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.reconnectAfterMs" + }, + "524": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.headers" + }, + "525": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "526": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "528": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.params" + }, + "529": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "530": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "532": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.log_level" + }, + "533": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.logLevel" + }, + "534": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.fetch" + }, + "535": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.worker" + }, + "536": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.workerUrl" + }, + "537": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.accessToken" + }, + "538": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "539": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "540": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeMessage" + }, + "541": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "542": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.topic" + }, + "543": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.event" + }, + "544": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.payload" + }, + "545": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.ref" + }, + "546": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.join_ref" + }, + "547": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesFilter" + }, + "548": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "549": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "550": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.schema" + }, + "551": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.table" + }, + "552": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.filter" + }, + "553": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "554": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayload" + }, + "555": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "556": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "557": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "559": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresInsertPayload" + }, + "560": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "561": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "562": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "563": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "564": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "565": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "566": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "567": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "569": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresUpdatePayload" + }, + "570": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "571": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "572": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "573": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "574": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "575": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "576": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "578": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresDeletePayload" + }, + "579": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "580": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "581": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "582": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "583": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "584": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "585": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "586": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "588": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceJoinPayload" + }, + "589": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "590": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.event" + }, + "591": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.key" + }, + "592": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.currentPresences" + }, + "593": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.newPresences" + }, + "594": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "595": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "596": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "598": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceLeavePayload" + }, + "599": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "600": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.event" + }, + "601": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.key" + }, + "602": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.currentPresences" + }, + "603": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.leftPresences" + }, + "604": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "605": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "606": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "608": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceState" + }, + "609": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "610": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "612": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "613": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "614": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "616": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "617": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeRemoveChannelResponse" + }, + "618": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES" + }, + "619": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" + }, + "620": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" + }, + "621": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" + }, + "622": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" + }, + "623": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" + }, + "624": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" + }, + "625": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + }, + "626": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + }, + "627": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + }, + "628": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" + }, + "629": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" + }, + "630": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" + }, + "631": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" + }, + "632": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES" + }, + "633": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" + }, + "634": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" + }, + "635": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" + }, + "636": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" + }, + "637": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_CHANNEL_STATES" + } + }, + "files": { + "entries": { + "1": "src/index.ts" + }, + "reflections": { + "1": 0 + } + } } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json index efdf6dc3142..53cfb41533f 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json @@ -1,8795 +1,633 @@ { "id": 0, "name": "@supabase/realtime-js", + "variant": "project", "kind": 1, - "kindString": "Project", "flags": {}, - "originalName": "", "children": [ { - "id": 614, + "id": 618, "name": "REALTIME_LISTEN_TYPES", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 615, + "id": 619, "name": "BROADCAST", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 98, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L98" } ], "type": { "type": "literal", "value": "broadcast" - }, - "defaultValue": "\"broadcast\"" + } }, { - "id": 617, + "id": 621, "name": "POSTGRES_CHANGES", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 100, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L100" } ], "type": { "type": "literal", "value": "postgres_changes" - }, - "defaultValue": "\"postgres_changes\"" + } }, { - "id": 616, + "id": 620, "name": "PRESENCE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L99" } ], "type": { "type": "literal", "value": "presence" - }, - "defaultValue": "\"presence\"" + } }, { - "id": 618, + "id": 622, "name": "SYSTEM", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L101" } ], "type": { "type": "literal", "value": "system" - }, - "defaultValue": "\"system\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [615, 617, 616, 618] + "children": [619, 621, 620, 622] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 97, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L97" } ] }, { - "id": 619, + "id": 623, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 620, + "id": 624, "name": "ALL", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L91" } ], "type": { "type": "literal", "value": "*" - }, - "defaultValue": "\"*\"" + } }, { - "id": 623, + "id": 627, "name": "DELETE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L94" } ], "type": { "type": "literal", "value": "DELETE" - }, - "defaultValue": "\"DELETE\"" + } }, { - "id": 621, + "id": 625, "name": "INSERT", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 92, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L92" } ], "type": { "type": "literal", "value": "INSERT" - }, - "defaultValue": "\"INSERT\"" + } }, { - "id": 622, + "id": 626, "name": "UPDATE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 93, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L93" } ], "type": { "type": "literal", "value": "UPDATE" - }, - "defaultValue": "\"UPDATE\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [620, 623, 621, 622] + "children": [624, 627, 625, 626] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 90, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L90" } ] }, { - "id": 624, + "id": 628, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 626, + "id": 630, "name": "JOIN", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L37" } ], "type": { "type": "literal", "value": "join" - }, - "defaultValue": "\"join\"" + } }, { - "id": 627, + "id": 631, "name": "LEAVE", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L38" } ], "type": { "type": "literal", "value": "leave" - }, - "defaultValue": "\"leave\"" + } }, { - "id": 625, + "id": 629, "name": "SYNC", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L36" } ], "type": { "type": "literal", "value": "sync" - }, - "defaultValue": "\"sync\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [626, 627, 625] + "children": [630, 631, 629] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 35, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L35" } ] }, { - "id": 628, + "id": 632, "name": "REALTIME_SUBSCRIBE_STATES", + "variant": "declaration", "kind": 8, - "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 632, + "id": 636, "name": "CHANNEL_ERROR", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 108, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L108" } ], "type": { "type": "literal", "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" + } }, { - "id": 631, + "id": 635, "name": "CLOSED", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 107, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L107" } ], "type": { "type": "literal", "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" + } }, { - "id": 629, + "id": 633, "name": "SUBSCRIBED", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 105, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L105" } ], "type": { "type": "literal", "value": "SUBSCRIBED" - }, - "defaultValue": "\"SUBSCRIBED\"" + } }, { - "id": 630, + "id": 634, "name": "TIMED_OUT", + "variant": "declaration", "kind": 16, - "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 106, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L106" } ], "type": { "type": "literal", "value": "TIMED_OUT" - }, - "defaultValue": "\"TIMED_OUT\"" + } } ], "groups": [ { "title": "Enumeration Members", - "kind": 16, - "children": [632, 631, 629, 630] + "children": [636, 635, 633, 634] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 104, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L104" } ] }, { - "id": 64, + "id": 65, "name": "RealtimeChannel", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + "summary": [ + { + "kind": "text", + "text": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + } + ] }, "children": [ { - "id": 75, + "id": 76, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 147, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L147" } ], "signatures": [ { - "id": 76, - "name": "new RealtimeChannel", + "id": 77, + "name": "RealtimeChannel", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 147, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L147" + } + ], "parameters": [ { - "id": 77, + "id": 78, "name": "topic", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 78, + "id": 79, "name": "params", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 358, + "target": 359, "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } + "package": "@supabase/realtime-js" }, "defaultValue": "..." }, { - "id": 79, + "id": 80, "name": "socket", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, - 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, - 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, - 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, - 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 80, + "id": 81, "name": "bindings", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 128, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L128" } ], "type": { "type": "reflection", "declaration": { - "id": 81, + "id": 82, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 + "line": 128, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L128" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "indexSignatures": [ + { + "id": 83, + "name": "__index", + "variant": "signature", + "kind": 8192, "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 36, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 84, - "character": 2 + "line": 129, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L129" } ], - "signatures": [ + "parameters": [ { - "id": 37, - "name": "new RealtimePresence", - "kind": 16384, - "kindString": "Constructor signature", + "id": 84, + "name": "key", + "variant": "param", + "kind": 32768, "flags": {}, - "comment": { - "shortText": "Initializes the Presence." - }, - "parameters": [ - { - "id": 38, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The RealtimeChannel" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - }, - { - "id": 39, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" - }, - "type": { - "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" - } - } - ], "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 44, - "name": "caller", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 45, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 46, - "name": "onJoin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 68, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" - } - }, - { - "id": 47, - "name": "onLeave", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 69, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" - } - }, - { - "id": 48, - "name": "onSync", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 70, - "character": 4 - } - ], - "signatures": [ - { - "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, - { - "title": "Methods", - "kind": 2048, - "children": [48] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 50, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - }, - { - "id": 43, - "name": "joinRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { "type": "intrinsic", "name": "string" } - ] - }, - "defaultValue": "null" - }, - { - "id": 42, - "name": "pendingDiffs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 65, - "character": 2 } ], "type": { "type": "array", "elementType": { - "type": "reference", - "name": "RawPresenceDiff" - } - }, - "defaultValue": "[]" - }, - { - "id": 40, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 41, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ], - "name": "RealtimePresenceState", - "dereferenced": { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", + "type": "reflection", + "declaration": { + "id": 85, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 91, + "name": "callback", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 132, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L132" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 87, + "name": "filter", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 88, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "parameters": [ + "sources": [ { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" } ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 605, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 75 - } - ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ + "indexSignatures": [ { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } - } - } - } - } - } - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, - 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": "[Circular ~.children.4.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, - 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, + "id": 89, "name": "__index", + "variant": "signature", "kind": 8192, - "kindString": "Index signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L131" + } + ], "parameters": [ { - "id": 228, + "id": 90, "name": "key", + "variant": "param", "kind": 32768, "flags": {}, "type": { @@ -8803,7 +641,794 @@ "name": "any" } } - } + ] + } + } + }, + { + "id": 92, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 133, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L133" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 86, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L130" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [91, 87, 92, 86] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 129, + "character": 19, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L129" + } + ] + } + } + } + } + ] + } + }, + "defaultValue": "{}" + }, + { + "id": 100, + "name": "broadcastEndpointURL", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 143, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L143" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 95, + "name": "joinedOnce", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 138, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L138" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 96, + "name": "joinPush", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 139, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L139" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 104, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 150, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L150" + } + ], + "type": { + "type": "reference", + "target": 359, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" + }, + "defaultValue": "..." + }, + { + "id": 99, + "name": "presence", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 142, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L142" + } + ], + "type": { + "type": "reference", + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 102, + "name": "private", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L145" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 98, + "name": "pushBuffer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 141, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L141" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + "defaultValue": "[]" + }, + { + "id": 97, + "name": "rejoinTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 140, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L140" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 105, + "name": "socket", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 151, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L151" + } + ], + "type": { + "type": "reference", + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 94, + "name": "state", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 137, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L137" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CHANNEL_STATES" + }, + "name": "CHANNEL_STATES", + "package": "@supabase/realtime-js" + }, + "defaultValue": "CHANNEL_STATES.closed" + }, + { + "id": 101, + "name": "subTopic", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L144" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 93, + "name": "timeout", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 136, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L136" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 103, + "name": "topic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 149, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L149" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 137, + "name": "on", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 350, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L350" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 391, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L391" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 414, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L414" + } + ], + "signatures": [ + { + "id": 138, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 350, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L350" + } + ], + "parameters": [ + { + "id": 139, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 140, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 141, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 142, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 352, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L352" + } + ], + "type": { + "type": "literal", + "value": "sync" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [142] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 352, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L352" + } + ] + } + } + }, + { + "id": 143, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 144, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 353, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L353" + } + ], + "signatures": [ + { + "id": 145, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 353, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L353" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 146, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "typeParameters": [ + { + "id": 147, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 148, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "indexSignatures": [ + { + "id": 149, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L355" + } + ], + "parameters": [ + { + "id": 150, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 151, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 152, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 153, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 154, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 357, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L357" + } + ], + "type": { + "type": "literal", + "value": "join" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [154] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 357, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L357" + } + ] + } + } + }, + { + "id": 155, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 156, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 358, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L358" + } + ], + "signatures": [ + { + "id": 157, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 358, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L358" + } + ], + "parameters": [ + { + "id": 158, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 588, + "typeArguments": [ + { + "type": "reference", + "target": 147, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceJoinPayload", + "package": "@supabase/realtime-js" } } ], @@ -8819,96 +1444,1087 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 229, + "id": 159, "name": "on", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ { - "id": 233, + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + } + ], + "typeParameters": [ + { + "id": 160, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 230, + "id": 161, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" } - } + ], + "indexSignatures": [ + { + "id": 162, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 360, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L360" + } + ], + "parameters": [ + { + "id": 163, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } ], "parameters": [ { - "id": 234, + "id": 164, "name": "type", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 165, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 167, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 362, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L362" + } + ], + "type": { + "type": "literal", + "value": "leave" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [167] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 362, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L362" + } + ] + } + } + }, + { + "id": 168, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 169, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 363, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L363" + } + ], + "signatures": [ + { + "id": 170, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 363, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L363" + } + ], + "parameters": [ + { + "id": 171, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 598, + "typeArguments": [ + { + "type": "reference", + "target": 160, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceLeavePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 172, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "typeParameters": [ + { + "id": 173, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 174, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "indexSignatures": [ + { + "id": 175, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 365, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L365" + } + ], + "parameters": [ + { + "id": 176, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 177, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 178, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "*" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 179, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 368, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L368" + } + ], + "signatures": [ + { + "id": 181, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 368, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L368" + } + ], + "parameters": [ + { + "id": 182, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 554, + "typeArguments": [ + { + "type": "reference", + "target": 173, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresChangesPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 183, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "typeParameters": [ + { + "id": 184, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 185, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "indexSignatures": [ + { + "id": 186, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L370" + } + ], + "parameters": [ + { + "id": 187, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 188, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 189, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "INSERT" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 190, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 191, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L373" + } + ], + "signatures": [ + { + "id": 192, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L373" + } + ], + "parameters": [ + { + "id": 193, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 559, + "typeArguments": [ + { + "type": "reference", + "target": 184, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresInsertPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 194, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "typeParameters": [ + { + "id": 195, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 196, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "indexSignatures": [ + { + "id": 197, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L375" + } + ], + "parameters": [ + { + "id": 198, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 199, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 200, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "UPDATE" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 201, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 202, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L378" + } + ], + "signatures": [ + { + "id": 203, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L378" + } + ], + "parameters": [ + { + "id": 204, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 569, + "typeArguments": [ + { + "type": "reference", + "target": 195, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresUpdatePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 205, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "typeParameters": [ + { + "id": 206, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 207, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "indexSignatures": [ + { + "id": 208, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L380" + } + ], + "parameters": [ + { + "id": 209, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 210, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 211, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 547, + "typeArguments": [ + { + "type": "literal", + "value": "DELETE" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 212, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 213, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L383" + } + ], + "signatures": [ + { + "id": 214, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L383" + } + ], + "parameters": [ + { + "id": 215, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 578, + "typeArguments": [ + { + "type": "reference", + "target": 206, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresDeletePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 216, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 391, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L391" + } + ], + "parameters": [ + { + "id": 217, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." + } + ] + }, "type": { "type": "literal", "value": "broadcast" } }, { - "id": 235, + "id": 218, "name": "filter", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom object specific to the Realtime feature detailing which payloads to receive." + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 236, + "id": 219, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 237, + "id": 220, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 + "line": 393, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L393" } ], "type": { @@ -8920,61 +2536,93 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [237] + "children": [220] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 393, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L393" } ] } } }, { - "id": 238, + "id": 221, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Function to be invoked when event handler is triggered." + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 239, + "id": 222, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], "signatures": [ { - "id": 240, + "id": 223, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], "parameters": [ { - "id": 241, + "id": 224, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 242, + "id": 225, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 244, + "id": 227, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 + "line": 396, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L396" } ], "type": { @@ -8983,35 +2631,17 @@ } }, { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, + "id": 226, "name": "type", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 + "line": 395, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L395" } ], "type": { @@ -9023,8 +2653,49 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] + "children": [227, 226] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 394, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L394" + } + ], + "indexSignatures": [ + { + "id": 228, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 397, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L397" + } + ], + "parameters": [ + { + "id": 229, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } } ] } @@ -9043,64 +2714,398 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 246, + "id": 230, "name": "on", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ { - "id": 250, + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + } + ], + "typeParameters": [ + { + "id": 231, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 247, + "id": 232, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" } - } + ], + "indexSignatures": [ + { + "id": 233, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L400" + } + ], + "parameters": [ + { + "id": 234, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } ], "parameters": [ { - "id": 251, + "id": 235, "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "broadcast" + } + }, + { + "id": 236, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 238, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 402, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L402" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [238] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 402, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L402" + } + ] + } + } + }, + { + "id": 239, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 240, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ], + "signatures": [ + { + "id": 241, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ], + "parameters": [ + { + "id": 242, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 243, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 245, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 405, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L405" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 246, + "name": "payload", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 406, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L406" + } + ], + "type": { + "type": "reference", + "target": 231, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + }, + { + "id": 244, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 404, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L404" + } + ], + "type": { + "type": "literal", + "value": "broadcast" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [245, 246, 244] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L403" + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 247, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "typeParameters": [ + { + "id": 248, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 249, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "indexSignatures": [ + { + "id": 250, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 409, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L409" + } + ], + "parameters": [ + { + "id": 251, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 252, + "name": "type", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "literal", @@ -9108,49 +3113,65 @@ } }, { - "id": 252, + "id": 253, "name": "filter", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 253, + "id": 254, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } }, { - "id": 254, + "id": 255, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 256, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 412, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L412" + } + ], "signatures": [ { - "id": 256, + "id": 257, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 412, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L412" + } + ], "parameters": [ { - "id": 257, + "id": 258, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -9170,79 +3191,109 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 113, + "id": 114, "name": "presenceState", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 315, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L315" } ], "signatures": [ { - "id": 114, + "id": 115, "name": "presenceState", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, - "typeParameter": [ + "sources": [ { - "id": 119, + "fileName": "src/RealtimeChannel.ts", + "line": 315, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L315" + } + ], + "typeParameters": [ + { + "id": 116, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 115, + "id": 117, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 316, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L316" } - } + ], + "indexSignatures": [ + { + "id": 118, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 316, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L316" + } + ], + "parameters": [ + { + "id": 119, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "default": { "type": "reflection", "declaration": { - "id": 118, + "id": 120, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } @@ -9250,75 +3301,103 @@ ], "type": { "type": "reference", - "id": 604, + "target": 608, "typeArguments": [ { "type": "reference", - "id": 119, - "name": "T" + "target": 116, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "name": "RealtimePresenceState" + "name": "RealtimePresenceState", + "package": "@supabase/realtime-js" } } ] }, { - "id": 258, + "id": 259, "name": "send", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 430, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L430" } ], "signatures": [ { - "id": 259, + "id": 260, "name": "send", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a message into the channel." + "summary": [ + { + "kind": "text", + "text": "Sends a message into the channel." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 430, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L430" + } + ], "parameters": [ { - "id": 260, + "id": 261, "name": "args", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Arguments to send to channel" + "summary": [ + { + "kind": "text", + "text": "Arguments to send to channel" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 262, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 263, + "id": 264, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The name of the event being sent" + "summary": [ + { + "kind": "text", + "text": "The name of the event being sent" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 433, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L433" } ], "type": { @@ -9327,21 +3406,27 @@ } }, { - "id": 264, + "id": 265, "name": "payload", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Payload to be sent" + "summary": [ + { + "kind": "text", + "text": "Payload to be sent" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 434, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L434" } ], "type": { @@ -9350,19 +3435,25 @@ } }, { - "id": 262, + "id": 263, "name": "type", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of event to send" + "summary": [ + { + "kind": "text", + "text": "The type of event to send" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 432, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L432" } ], "type": { @@ -9387,76 +3478,118 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] + "children": [264, 265, 263] } ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 431, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L431" } - } + ], + "indexSignatures": [ + { + "id": 266, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 435, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L435" + } + ], + "parameters": [ + { + "id": 267, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } }, { - "id": 267, + "id": 268, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Options to be used during the send process\n" + "summary": [ + { + "kind": "text", + "text": "Options to be used during the send process" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 269, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 437, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L437" } - } + ], + "indexSignatures": [ + { + "id": 270, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 437, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L437" + } + ], + "parameters": [ + { + "id": 271, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -9464,93 +3597,131 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 105, + "id": 106, "name": "subscribe", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 213, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L213" } ], "signatures": [ { - "id": 106, + "id": 107, "name": "subscribe", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Subscribe registers your client with the server" + "summary": [ + { + "kind": "text", + "text": "Subscribe registers your client with the server" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 213, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L213" + } + ], "parameters": [ { - "id": 107, + "id": 108, "name": "callback", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 109, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 214, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L214" + } + ], "signatures": [ { - "id": 109, + "id": 110, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 214, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L214" + } + ], "parameters": [ { - "id": 110, + "id": 111, "name": "status", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" + "target": 632, + "name": "REALTIME_SUBSCRIBE_STATES", + "package": "@supabase/realtime-js" } }, { - "id": 111, + "id": 112, "name": "err", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" } } ], @@ -9564,10 +3735,10 @@ } }, { - "id": 112, + "id": 113, "name": "timeout", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -9578,110 +3749,159 @@ ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 120, + "id": 121, "name": "track", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 321, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L321" } ], "signatures": [ { - "id": 121, + "id": 122, "name": "track", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 321, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L321" + } + ], "parameters": [ { - "id": 122, + "id": 123, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 123, + "id": 124, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 322, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L322" } - } + ], + "indexSignatures": [ + { + "id": 125, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 322, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L322" + } + ], + "parameters": [ + { + "id": 126, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } }, { - "id": 126, + "id": 127, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 127, + "id": 128, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 323, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L323" } - } + ], + "indexSignatures": [ + { + "id": 129, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 323, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L323" + } + ], + "parameters": [ + { + "id": 130, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -9689,50 +3909,75 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 277, + "id": 278, "name": "unsubscribe", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 507, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L507" } ], "signatures": [ { - "id": 278, + "id": 279, "name": "unsubscribe", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" + "summary": [ + { + "kind": "text", + "text": "Leaves the channel.\n\nUnsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a " + }, + { + "kind": "code", + "text": "`receive`" + }, + { + "kind": "text", + "text": " hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 507, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L507" + } + ], "parameters": [ { - "id": 279, + "id": 280, "name": "timeout", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -9743,6 +3988,10 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "union", @@ -9762,71 +4011,98 @@ ] } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 130, + "id": 131, "name": "untrack", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 335, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L335" } ], "signatures": [ { - "id": 131, + "id": 132, "name": "untrack", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 335, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L335" + } + ], "parameters": [ { - "id": 132, + "id": 133, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 133, + "id": 134, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 336, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L336" } - } + ], + "indexSignatures": [ + { + "id": 135, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 336, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L336" + } + ], + "parameters": [ + { + "id": 136, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } }, "defaultValue": "{}" @@ -9834,78 +4110,110 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 271, + "id": 272, "name": "updateJoinPayload", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 494, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" } ], "signatures": [ { - "id": 272, + "id": 273, "name": "updateJoinPayload", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" + } + ], "parameters": [ { - "id": 273, + "id": 274, "name": "payload", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 275, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 29, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" } - } + ], + "indexSignatures": [ + { + "id": 276, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 494, + "character": 31, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L494" + } + ], + "parameters": [ + { + "id": 277, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } } } @@ -9921,67 +4229,84 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [75] + "children": [76] }, { "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] + "children": [81, 100, 95, 96, 104, 99, 102, 98, 97, 105, 94, 101, 93, 103] }, { "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] + "children": [137, 114, 259, 106, 121, 278, 131, 272] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 127, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L127" } ] }, { - "id": 371, + "id": 372, "name": "RealtimeClient", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "children": [ { - "id": 372, + "id": 373, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L144" } ], "signatures": [ { - "id": 373, - "name": "new RealtimeClient", + "id": 374, + "name": "RealtimeClient", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Initializes the Socket." + "summary": [ + { + "kind": "text", + "text": "Initializes the Socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L144" + } + ], "parameters": [ { - "id": 374, + "id": 375, "name": "endPoint", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + "summary": [ + { + "kind": "text", + "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + } + ] }, "type": { "type": "intrinsic", @@ -9989,489 +4314,125 @@ } }, { - "id": 375, + "id": 376, "name": "options", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "id": 513, + "target": 515, "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ + "package": "@supabase/realtime-js", + "highlightedProperties": { + "transport": [ { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 + "kind": "text", + "text": "The Websocket Transport, for example WebSocket. This can be a custom implementation" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] + "timeout": [ + { + "kind": "text", + "text": "The default timeout in milliseconds to trigger push timeouts." } - } + ], + "params": [ + { + "kind": "text", + "text": "The optional params to pass when connecting." + } + ], + "headers": [ + { + "kind": "text", + "text": "The optional headers to pass when connecting." + } + ], + "heartbeatIntervalMs": [ + { + "kind": "text", + "text": "The millisec interval to send a heartbeat message." + } + ], + "logger": [ + { + "kind": "text", + "text": "The optional function for specialized logging, ie: logger: (kind, msg, data) => { console.log(" + }, + { + "kind": "code", + "text": "`${kind}: ${msg}`" + }, + { + "kind": "text", + "text": ", data) }" + } + ], + "logLevel": [ + { + "kind": "text", + "text": "Sets the log level for Realtime" + } + ], + "encode": [ + { + "kind": "text", + "text": "The function to encode outgoing messages. Defaults to JSON: (payload, callback) => callback(JSON.stringify(payload))" + } + ], + "decode": [ + { + "kind": "text", + "text": "The function to decode incoming messages. Defaults to Serializer's decode." + } + ], + "reconnectAfterMs": [ + { + "kind": "text", + "text": "he optional function that returns the millsec reconnect interval. Defaults to stepped backoff off." + } + ], + "worker": [ + { + "kind": "text", + "text": "Use Web Worker to set a side flow. Defaults to false." + } + ], + "workerUrl": [ + { + "kind": "text", + "text": "The URL of the worker script. Defaults to https://realtime.supabase.com/worker.js that includes a heartbeat event call to keep the connection alive." + } + ] } } } ], "type": { "type": "reference", - "id": 371, - "name": "default" + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 417, + "id": 419, "name": "accessToken", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" } ], "type": { @@ -10484,20 +4445,40 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 420, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" + } + ], "signatures": [ { - "id": 419, + "id": 421, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L121" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "union", @@ -10513,9 +4494,8 @@ ] } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -10525,45 +4505,18 @@ }, "defaultValue": "null" }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, { "id": 377, - "name": "apiKey", + "name": "accessTokenValue", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 + "line": 87, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L87" } ], "type": { @@ -10583,38 +4536,71 @@ }, { "id": 378, - "name": "channels", + "name": "apiKey", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 + "line": 88, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L88" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 379, + "name": "channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 89, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L89" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, "defaultValue": "[]" }, { - "id": 400, + "id": 402, "name": "conn", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 + "line": 106, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L106" } ], "type": { @@ -10626,63 +4612,77 @@ }, { "type": "reference", - "name": "WebSocketLike" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLike" + }, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" } ] }, "defaultValue": "null" }, { - "id": 398, + "id": 400, "name": "decode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 + "line": 104, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L104" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 397, + "id": 399, "name": "encode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 + "line": 103, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L103" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 379, + "id": 380, "name": "endPoint", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 + "line": 90, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L90" } ], "type": { @@ -10692,101 +4692,159 @@ "defaultValue": "''" }, { - "id": 409, + "id": 411, "name": "fetch", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 + "line": 120, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L120" } ], "type": { "type": "reflection", "declaration": { - "id": 410, + "id": 412, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 28708, + "character": 17 + }, + { + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], "signatures": [ { - "id": 411, + "id": 413, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 28708, + "character": 17 + } + ], "parameters": [ { - "id": 412, + "id": 414, "name": "input", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInfo" + }, + "name": "RequestInfo", + "package": "typescript" }, { "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } ] } }, { - "id": 413, + "id": 415, "name": "init", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } }, { - "id": 414, + "id": 416, "name": "__type", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], "parameters": [ { - "id": 415, + "id": 417, "name": "input", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "union", @@ -10797,48 +4855,63 @@ }, { "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Request" + }, + "name": "Request", + "package": "typescript" }, { "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } ] } }, { - "id": 416, + "id": 418, "name": "init", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -10846,85 +4919,107 @@ } }, { - "id": 381, + "id": 382, "name": "headers", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 + "line": 92, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" } ], "type": { "type": "reflection", "declaration": { - "id": 382, + "id": 383, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 92, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" } - } + ], + "indexSignatures": [ + { + "id": 384, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 92, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L92" + } + ], + "parameters": [ + { + "id": 385, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } }, "defaultValue": "DEFAULT_HEADERS" }, { - "id": 391, + "id": 392, "name": "heartbeatIntervalMs", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L96" } ], "type": { "type": "intrinsic", "name": "number" }, - "defaultValue": "30000" + "defaultValue": "25000" }, { - "id": 392, + "id": 393, "name": "heartbeatTimer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 + "line": 97, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L97" } ], "type": { @@ -10936,25 +5031,30 @@ }, { "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", + "target": { + "sourceFileName": "node_modules/@types/node/timers.d.ts", + "qualifiedName": "__global.NodeJS.Timeout" + }, + "name": "Timeout", "package": "@types/node", - "name": "Timeout" + "qualifiedName": "__global.NodeJS.Timeout" } ] }, "defaultValue": "undefined" }, { - "id": 380, + "id": 381, "name": "httpEndpoint", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 + "line": 91, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L91" } ], "type": { @@ -10964,87 +5064,138 @@ "defaultValue": "''" }, { - "id": 396, + "id": 397, "name": "logger", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 + "line": 101, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L101" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" }, "defaultValue": "noop" }, { - "id": 385, - "name": "params", + "id": 398, + "name": "logLevel", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 + "line": 102, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L102" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "LOG_LEVEL" + }, + "name": "LOG_LEVEL", + "package": "@supabase/realtime-js" + } + }, + { + "id": 386, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" } ], "type": { "type": "reflection", "declaration": { - "id": 386, + "id": 387, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" } - } + ], + "indexSignatures": [ + { + "id": 388, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 93, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L93" + } + ], + "parameters": [ + { + "id": 389, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } }, "defaultValue": "{}" }, { - "id": 393, + "id": 394, "name": "pendingHeartbeatRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 + "line": 98, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L98" } ], "type": { @@ -11063,54 +5214,66 @@ "defaultValue": "null" }, { - "id": 399, + "id": 401, "name": "reconnectAfterMs", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L105" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 396, + "name": "reconnectTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 100, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L100" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 395, + "name": "ref", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L99" } ], "type": { @@ -11120,159 +5283,187 @@ "defaultValue": "0" }, { - "id": 401, + "id": 403, "name": "sendBuffer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 + "line": 107, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L107" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, "defaultValue": "[]" }, { - "id": 402, + "id": 404, "name": "serializer", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 + "line": 108, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L108" } ], "type": { "type": "reference", - "name": "default" + "target": { + "sourceFileName": "src/lib/serializer.ts", + "qualifiedName": "default" + }, + "name": "Serializer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" }, "defaultValue": "..." }, { - "id": 403, + "id": 405, "name": "stateChangeCallbacks", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 + "line": 109, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L109" } ], "type": { "type": "reflection", "declaration": { - "id": 404, + "id": 406, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 406, + "id": 408, "name": "close", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 + "line": 111, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L111" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + } + }, + { + "id": 409, + "name": "error", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 112, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L112" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + } + }, + { + "id": 410, + "name": "message", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 113, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L113" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } }, { "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, "name": "open", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 + "line": 110, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L110" } ], "type": { "type": "array", "elementType": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } } @@ -11280,8 +5471,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] + "children": [408, 409, 410, 407] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 109, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L109" } ] } @@ -11289,16 +5487,17 @@ "defaultValue": "..." }, { - "id": 389, + "id": 390, "name": "timeout", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 + "line": 94, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L94" } ], "type": { @@ -11308,16 +5507,17 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 390, + "id": 391, "name": "transport", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 + "line": 95, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L95" } ], "type": { @@ -11329,24 +5529,30 @@ }, { "type": "reference", - "name": "WebSocketLikeConstructor" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "name": "WebSocketLikeConstructor", + "package": "@supabase/realtime-js" } ] } }, { - "id": 420, + "id": 422, "name": "worker", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 + "line": 122, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L122" } ], "type": { @@ -11355,40 +5561,45 @@ } }, { - "id": 422, + "id": 424, "name": "workerRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 + "line": 124, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L124" } ], "type": { "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Worker" + }, + "name": "Worker", + "package": "typescript" } }, { - "id": 421, + "id": 423, "name": "workerUrl", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 + "line": 123, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L123" } ], "type": { @@ -11397,82 +5608,40 @@ } }, { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, + "id": 449, "name": "channel", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L331" } ], "signatures": [ { - "id": 448, + "id": 450, "name": "channel", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L331" + } + ], "parameters": [ { - "id": 449, + "id": 451, "name": "topic", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", @@ -11480,303 +5649,67 @@ } }, { - "id": 450, + "id": 452, "name": "params", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 358, + "target": 359, "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } + "package": "@supabase/realtime-js" }, "defaultValue": "..." } ], "type": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 423, + "id": 425, "name": "connect", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 + "line": 202, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L202" } ], "signatures": [ { - "id": 424, + "id": 426, "name": "connect", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Connects the socket, unless already connected." + "summary": [ + { + "kind": "text", + "text": "Connects the socket, unless already connected." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 202, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L202" + } + ], "type": { "type": "intrinsic", "name": "void" @@ -11785,69 +5718,107 @@ ] }, { - "id": 443, + "id": 445, "name": "connectionState", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 + "line": 311, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L311" } ], "signatures": [ { - "id": 444, + "id": 446, "name": "connectionState", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the current state of the socket." + "summary": [ + { + "kind": "text", + "text": "Returns the current state of the socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 311, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L311" + } + ], "type": { "type": "reference", - "name": "CONNECTION_STATE" + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CONNECTION_STATE" + }, + "name": "CONNECTION_STATE", + "package": "@supabase/realtime-js" } } ] }, { - "id": 427, + "id": 429, "name": "disconnect", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 + "line": 252, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L252" } ], "signatures": [ { - "id": 428, + "id": 430, "name": "disconnect", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Disconnects the socket." + "summary": [ + { + "kind": "text", + "text": "Disconnects the socket." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 252, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L252" + } + ], "parameters": [ { - "id": 429, + "id": 431, "name": "code", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "A numeric status code to send on disconnect." + "summary": [ + { + "kind": "text", + "text": "A numeric status code to send on disconnect." + } + ] }, "type": { "type": "intrinsic", @@ -11855,15 +5826,20 @@ } }, { - "id": 430, + "id": 432, "name": "reason", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "A custom reason for the disconnect.\n" + "summary": [ + { + "kind": "text", + "text": "A custom reason for the disconnect." + } + ] }, "type": { "type": "intrinsic", @@ -11879,29 +5855,53 @@ ] }, { - "id": 425, + "id": 427, "name": "endpointURL", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 + "line": 239, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L239" } ], "signatures": [ { - "id": 426, + "id": 428, "name": "endpointURL", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" + "summary": [ + { + "kind": "text", + "text": "Returns the URL of the websocket." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "string The URL of the websocket." + } + ] + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 239, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L239" + } + ], "type": { "type": "intrinsic", "name": "string" @@ -11910,28 +5910,42 @@ ] }, { - "id": 459, + "id": 461, "name": "flushSendBuffer", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 + "line": 421, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L421" } ], "signatures": [ { - "id": 460, + "id": 462, "name": "flushSendBuffer", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Flushes send buffer" + "summary": [ + { + "kind": "text", + "text": "Flushes send buffer" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 421, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L421" + } + ], "type": { "type": "intrinsic", "name": "void" @@ -11940,62 +5954,100 @@ ] }, { - "id": 431, + "id": 433, "name": "getChannels", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 + "line": 270, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L270" } ], "signatures": [ { - "id": 432, + "id": 434, "name": "getChannels", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns all created channels" + "summary": [ + { + "kind": "text", + "text": "Returns all created channels" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 270, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L270" + } + ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 64, - "name": "default" + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } } ] }, { - "id": 445, + "id": 447, "name": "isConnected", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 + "line": 327, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L327" } ], "signatures": [ { - "id": 446, + "id": 448, "name": "isConnected", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns `true` is the connection is open." + "summary": [ + { + "kind": "text", + "text": "Returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " is the connection is open." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 327, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L327" + } + ], "type": { "type": "intrinsic", "name": "boolean" @@ -12004,57 +6056,78 @@ ] }, { - "id": 438, + "id": 440, "name": "log", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 + "line": 304, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L304" } ], "signatures": [ { - "id": 439, + "id": 441, "name": "log", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" + "summary": [ + { + "kind": "text", + "text": "Logs the message.\n\nFor customized logging, " + }, + { + "kind": "code", + "text": "`this.logger`" + }, + { + "kind": "text", + "text": " can be overridden." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 304, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L304" + } + ], "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 442, + "name": "kind", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "msg", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 444, "name": "data", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, @@ -12072,172 +6145,54 @@ ] }, { - "id": 451, + "id": 453, "name": "push", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 + "line": 345, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L345" } ], "signatures": [ { - "id": 452, + "id": 454, "name": "push", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" + "summary": [ + { + "kind": "text", + "text": "Push out a message if the socket is connected.\n\nIf the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 345, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L345" + } + ], "parameters": [ { - "id": 453, + "id": 455, "name": "data", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 536, + "target": 540, "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } + "package": "@supabase/realtime-js" } } ], @@ -12249,4590 +6204,260 @@ ] }, { - "id": 436, + "id": 438, "name": "removeAllChannels", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 + "line": 291, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L291" } ], "signatures": [ { - "id": 437, + "id": 439, "name": "removeAllChannels", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes all channels" + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes all channels" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 291, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L291" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" + "target": 617, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" } } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 433, + "id": 435, "name": "removeChannel", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 + "line": 278, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L278" } ], "signatures": [ { - "id": 434, + "id": 436, "name": "removeChannel", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes a single channel" + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes a single channel" + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 278, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L278" + } + ], "parameters": [ { - "id": 435, + "id": 437, "name": "channel", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A RealtimeChannel instance\n" + "summary": [ + { + "kind": "text", + "text": "A RealtimeChannel instance" + } + ] }, "type": { "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.5.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, - 392, 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, - 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, - 436, 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 80, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 36, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 84, - "character": 2 - } - ], - "signatures": [ - { - "id": 37, - "name": "new RealtimePresence", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Presence." - }, - "parameters": [ - { - "id": 38, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The RealtimeChannel" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" - } - }, - { - "id": 39, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" - }, - "type": { - "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 44, - "name": "caller", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 45, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 46, - "name": "onJoin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 68, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" - } - }, - { - "id": 47, - "name": "onLeave", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 69, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" - } - }, - { - "id": 48, - "name": "onSync", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 70, - "character": 4 - } - ], - "signatures": [ - { - "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, - { - "title": "Methods", - "kind": 2048, - "children": [48] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 50, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" - } - }, - { - "id": 43, - "name": "joinRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 42, - "name": "pendingDiffs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 65, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "RawPresenceDiff" - } - }, - "defaultValue": "[]" - }, - { - "id": 40, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 41, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ], - "name": "RealtimePresenceState", - "dereferenced": { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 605, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 75 - } - ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } - } - } - } - } - } - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.5.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, - 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, - 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, - 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 228, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 229, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 233, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 234, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 235, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 236, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 237, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [237] - } - ] - } - } - }, - { - "id": 238, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 239, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 240, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 241, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 242, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 244, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 246, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 250, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 247, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 251, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 252, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 253, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 254, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 256, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 257, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 114, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 119, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "T" - } - ], - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 258, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 430, - "character": 8 - } - ], - "signatures": [ - { - "id": 259, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a message into the channel." - }, - "parameters": [ - { - "id": 260, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Arguments to send to channel" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 263, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The name of the event being sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 433, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 264, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Payload to be sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 434, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 262, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of event to send" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 432, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] - } - ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 267, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Options to be used during the send process\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 268, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 105, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 107, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 109, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 110, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "id": 111, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 112, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 120, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 8 - } - ], - "signatures": [ - { - "id": 121, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 122, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 126, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 127, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 277, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 507, - "character": 2 - } - ], - "signatures": [ - { - "id": 278, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 279, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 130, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 335, - "character": 8 - } - ], - "signatures": [ - { - "id": 131, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 132, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 271, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 494, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 273, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" + "target": 617, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 457, + "id": 459, "name": "sendHeartbeat", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 + "line": 395, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L395" } ], "signatures": [ { - "id": 458, + "id": 460, "name": "sendHeartbeat", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." + "summary": [ + { + "kind": "text", + "text": "Sends a heartbeat message if the socket is connected." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 395, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L395" + } + ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] }, { - "id": 454, + "id": 456, "name": "setAuth", + "variant": "declaration", "kind": 2048, - "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 + "line": 369, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L369" } ], "signatures": [ { - "id": 455, + "id": 457, "name": "setAuth", + "variant": "signature", "kind": 4096, - "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.\n\nIf param is null it will use the " + }, + { + "kind": "code", + "text": "`accessToken`" + }, + { + "kind": "text", + "text": " callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 369, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L369" + } + ], "parameters": [ { - "id": 456, + "id": 458, "name": "token", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string to override the token set on the client.\n" + "summary": [ + { + "kind": "text", + "text": "A JWT string to override the token set on the client." + } + ] }, "type": { "type": "union", @@ -16852,15 +6477,18 @@ ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Promise", + "package": "typescript" } } ] @@ -16869,9119 +6497,133 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [372] + "children": [373] }, { "title": "Properties", - "kind": 1024, "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, 399, - 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 + 419, 377, 378, 379, 402, 400, 399, 380, 411, 382, 392, 393, 381, 397, 398, 386, 394, + 401, 396, 395, 403, 404, 405, 390, 391, 422, 424, 423 ] }, { "title": "Methods", - "kind": 2048, - "children": [510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454] + "children": [449, 425, 445, 429, 427, 461, 433, 447, 440, 453, 438, 435, 459, 456] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 + "line": 86, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L86" } ] }, { "id": 1, "name": "RealtimePresence", + "variant": "declaration", "kind": 128, - "kindString": "Class", "flags": {}, "children": [ { "id": 36, "name": "constructor", + "variant": "declaration", "kind": 512, - "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" } ], "signatures": [ { "id": 37, - "name": "new RealtimePresence", + "name": "RealtimePresence", + "variant": "signature", "kind": 16384, - "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Initializes the Presence." + "summary": [ + { + "kind": "text", + "text": "Initializes the Presence." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 84, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" + } + ], "parameters": [ { "id": 38, "name": "channel", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The RealtimeChannel" + "summary": [ + { + "kind": "text", + "text": "The RealtimeChannel" + } + ] }, "type": { "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, - 526, 521, 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.0.signatures.0.parameters.0.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, - 392, 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, - 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, - 436, 433, 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 80, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.6.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, - 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.0.signatures.0.parameters.0.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, - 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, - 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, - 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 228, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 229, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 233, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 234, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 235, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 236, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 237, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [237] - } - ] - } - } - }, - { - "id": 238, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 239, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 240, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 241, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 242, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 244, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 246, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 250, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 247, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 251, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 252, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 253, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 254, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 256, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 257, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 114, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 119, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "T" - } - ], - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 258, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 430, - "character": 8 - } - ], - "signatures": [ - { - "id": 259, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a message into the channel." - }, - "parameters": [ - { - "id": 260, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Arguments to send to channel" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 263, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The name of the event being sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 433, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 264, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Payload to be sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 434, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 262, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of event to send" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 432, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] - } - ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 267, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Options to be used during the send process\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 268, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 105, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 107, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 109, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 110, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "id": 111, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 112, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 120, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 8 - } - ], - "signatures": [ - { - "id": 121, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 122, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 126, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 127, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 277, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 507, - "character": 2 - } - ], - "signatures": [ - { - "id": 278, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 279, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 130, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 335, - "character": 8 - } - ], - "signatures": [ - { - "id": 131, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 132, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 271, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 494, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 273, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { "id": 39, "name": "opts", + "variant": "param", "kind": 32768, - "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" + "summary": [ + { + "kind": "text", + "text": "The options,\n for example " + }, + { + "kind": "code", + "text": "`{events: {state: 'state', diff: 'diff'}}`" + } + ] }, "type": { "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOpts" + }, + "name": "PresenceOpts", + "package": "@types/phoenix" } } ], "type": { "type": "reference", - "id": 1, - "name": "default" + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] @@ -25989,14 +6631,15 @@ { "id": 44, "name": "caller", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 67, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L67" } ], "type": { @@ -26004,88 +6647,125 @@ "declaration": { "id": 45, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { "id": 46, "name": "onJoin", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 68, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L68" } ], "type": { "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnJoinCallback" + }, + "name": "PresenceOnJoinCallback", + "package": "@types/phoenix" } }, { "id": 47, "name": "onLeave", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 69, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L69" } ], "type": { "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnLeaveCallback" + }, + "name": "PresenceOnLeaveCallback", + "package": "@types/phoenix" } }, { "id": 48, "name": "onSync", - "kind": 2048, - "kindString": "Method", + "variant": "declaration", + "kind": 1024, "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 70, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 70, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" + } + ], + "signatures": [ + { + "id": 50, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 70, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L70" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, + "children": [46, 47, 48] + } + ], + "sources": [ { - "title": "Methods", - "kind": 2048, - "children": [48] + "fileName": "src/RealtimePresence.ts", + "line": 67, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L67" } ] } @@ -26093,9048 +6773,49 @@ "defaultValue": "..." }, { - "id": 50, + "id": 51, "name": "channel", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isPublic": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The RealtimeChannel" + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 84, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L84" + } + ], "type": { "type": "reference", - "id": 64, - "name": "default", - "dereferenced": { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, - 516, 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.2.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, - 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, - 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, - 457, 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 80, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 99, - "name": "broadcastEndpointURL", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 103, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default", - "dereferenced": { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": "[Circular ~.children.6.children]", - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - } - } - }, - { - "id": 101, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 104, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 371, - "name": "default", - "dereferenced": { - "id": 371, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 372, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 137, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 374, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 513, - "name": "RealtimeClientOptions", - "dereferenced": { - "id": 513, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 522, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 521, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 516, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 515, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - }, - { - "id": 532, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 533, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, - 515, 532, 533 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "id": 371, - "name": "default" - } - } - ] - }, - { - "id": 417, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 419, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 376, - "name": "accessTokenValue", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 377, - "name": "apiKey", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 378, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 400, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLike" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 398, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 397, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 379, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 409, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 411, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 412, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 413, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - }, - { - "id": 414, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 415, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "Request", - "package": "typescript", - "name": "Request" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 416, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 381, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 383, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 391, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 392, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 380, - "name": "httpEndpoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 396, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 385, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 387, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 393, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 399, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 395, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 394, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 401, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 402, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 403, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 406, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 407, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 408, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 405, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406, 407, 408, 405] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 390, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "WebSocketLikeConstructor" - } - ] - } - }, - { - "id": 420, - "name": "worker", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "workerRef", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Worker", - "package": "typescript", - "name": "Worker" - } - }, - { - "id": 421, - "name": "workerUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "_workerObjectUrl", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 611, - "character": 10 - } - ], - "signatures": [ - { - "id": 511, - "name": "_workerObjectUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 512, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 447, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 358, - "name": "RealtimeChannelOptions", - "dereferenced": { - "id": 358, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 362, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 364] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 22, - "character": 16 - } - ] - } - } - }, - { - "id": 366, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 26, - "character": 15 - } - ] - } - } - }, - { - "id": 369, - "name": "private", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 37 - } - ] - } - } - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 423, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 443, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 299, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 427, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 240, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 429, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 425, - "name": "endpointURL", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "endpointURL", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the URL of the websocket.", - "returns": "string The URL of the websocket.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 459, - "name": "flushSendBuffer", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "flushSendBuffer", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Flushes send buffer" - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 431, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 258, - "character": 2 - } - ], - "signatures": [ - { - "id": 432, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 445, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 438, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 292, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 440, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 451, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 333, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 453, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "RealtimeMessage", - "dereferenced": { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 - } - ] - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 436, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 279, - "character": 8 - } - ], - "signatures": [ - { - "id": 437, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 433, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 266, - "character": 8 - } - ], - "signatures": [ - { - "id": 434, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 435, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default", - "dereferenced": "[Circular ~.children.6.children.2.type.dereferenced]" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 457, - "name": "sendHeartbeat", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 397, - "character": 8 - } - ], - "signatures": [ - { - "id": 458, - "name": "sendHeartbeat", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 454, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 357, - "character": 8 - } - ], - "signatures": [ - { - "id": 455, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", - "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" - }, - "parameters": [ - { - "id": 456, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string to override the token set on the client.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [372] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, - 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, - 454 - ] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 81, - "character": 21 - } - ] - } - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 100, - "name": "subTopic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 102, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 350, - "character": 2 - } - ], - "signatures": [ - { - "id": 137, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 138, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 139, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 352, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 144, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 145, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 149, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 147, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 151, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 357, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [153] - } - ] - } - } - }, - { - "id": 154, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 149, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 158, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 162, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 160, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 161, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 163, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 164, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166] - } - ] - } - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 594, - "typeArguments": [ - { - "type": "reference", - "id": 162, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 550, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 204, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 208, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 206, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 207, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 209, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 210, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "dereferenced": { - "id": 543, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 549, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 545, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 549, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 548, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 69, - "character": 4 - } - ] - } - } - } - } - }, - { - "id": 211, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 213, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "typeArguments": [ - { - "type": "reference", - "id": 208, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 215, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 216, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 217, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 219, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 393, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [219] - } - ] - } - } - }, - { - "id": 220, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 222, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 223, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 395, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 225] - } - ], - "indexSignature": { - "id": 227, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 228, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 229, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 233, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 234, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 235, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 236, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 237, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [237] - } - ] - } - } - }, - { - "id": 238, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 239, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 240, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 241, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 242, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 244, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 245, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 406, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 233, - "name": "T" - } - }, - { - "id": 243, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [244, 245, 243] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 246, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 250, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 247, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 248, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 249, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 251, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 252, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 253, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 254, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 256, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 257, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 114, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 119, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 116, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 117, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "id": 604, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "T" - } - ], - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 258, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 430, - "character": 8 - } - ], - "signatures": [ - { - "id": 259, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a message into the channel." - }, - "parameters": [ - { - "id": 260, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Arguments to send to channel" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 263, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The name of the event being sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 433, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 264, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Payload to be sent" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 434, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 262, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of event to send" - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 432, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [263, 264, 262] - } - ], - "indexSignature": { - "id": 265, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 266, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 267, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Options to be used during the send process\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 268, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 269, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 270, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 105, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 107, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 109, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 110, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 628, - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "id": 111, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 112, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 120, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 8 - } - ], - "signatures": [ - { - "id": 121, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 122, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 124, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 126, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 127, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 128, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 277, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 507, - "character": 2 - } - ], - "signatures": [ - { - "id": 278, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 279, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 130, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 335, - "character": 8 - } - ], - "signatures": [ - { - "id": 131, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 132, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 134, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 370, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 271, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 494, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 273, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 275, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 276, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] - }, - { - "title": "Methods", - "kind": 2048, - "children": [136, 113, 258, 105, 120, 277, 130, 271] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21 - } - ] - } + "target": 65, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { "id": 43, "name": "joinRef", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L66" } ], "type": { @@ -35155,21 +6836,27 @@ { "id": 42, "name": "pendingDiffs", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 65, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L65" } ], "type": { "type": "array", "elementType": { "type": "reference", - "name": "RawPresenceDiff" + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RawPresenceDiff" + }, + "name": "RawPresenceDiff", + "package": "@supabase/realtime-js" } }, "defaultValue": "[]" @@ -35177,162 +6864,34 @@ { "id": 40, "name": "state", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L64" } ], "type": { "type": "reference", - "id": 604, + "target": 608, "typeArguments": [ { "type": "reflection", "declaration": { "id": 41, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {} } } ], "name": "RealtimePresenceState", - "dereferenced": { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 605, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 75 - } - ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } - } - } - } - } - } + "package": "@supabase/realtime-js" }, "defaultValue": "{}" } @@ -35340,99 +6899,106 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [36] }, { "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [44, 51, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L63" } ] }, { - "id": 358, + "id": 359, "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 359, + "id": 360, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 361, "name": "config", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L17" } ], "type": { "type": "reflection", "declaration": { - "id": 361, + "id": 362, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 362, + "id": 363, "name": "broadcast", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + "summary": [ + { + "kind": "text", + "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { "type": "reflection", "declaration": { - "id": 363, + "id": 364, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 366, "name": "ack", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -35440,7 +7006,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { @@ -35449,10 +7016,10 @@ } }, { - "id": 364, + "id": 365, "name": "self", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -35460,7 +7027,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ], "type": { @@ -35472,52 +7040,58 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [365, 364] + "children": [366, 365] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 22, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L22" } ] } } }, { - "id": 366, + "id": 367, "name": "presence", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "key option is used to track presence payload across clients" + "summary": [ + { + "kind": "text", + "text": "key option is used to track presence payload across clients" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ], "type": { "type": "reflection", "declaration": { - "id": 367, + "id": 368, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 369, "name": "key", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, @@ -35525,7 +7099,8 @@ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ], "type": { @@ -35537,36 +7112,42 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [368] + "children": [369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 26, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L26" } ] } } }, { - "id": 369, + "id": 370, "name": "private", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + "summary": [ + { + "kind": "text", + "text": "defines if the channel is private or not and if RLS policies will be used to check data" + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 30, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L30" } ], "type": { @@ -35578,15 +7159,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [362, 366, 369] + "children": [363, 367, 370] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 17, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L17" } ] } @@ -35596,31 +7177,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [360] + "children": [361] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L16" } ] } } }, { - "id": 370, + "id": 371, "name": "RealtimeChannelSendResponse", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 88, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L88" } ], "type": { @@ -35642,317 +7224,257 @@ } }, { - "id": 513, + "id": 515, "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 12 + "line": 60, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L60" } ], "type": { "type": "reflection", "declaration": { - "id": 514, + "id": 516, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 520, - "name": "decode", + "id": 537, + "name": "accessToken", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, - "character": 2 + "line": 76, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L76" } ], "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 519, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 2 + "type": "reflection", + "declaration": { + "id": 538, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 76, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L76" + } + ], + "signatures": [ + { + "id": 539, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 531, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" } }, { "id": 522, - "name": "headers", + "name": "decode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "indexSignature": { - "id": 524, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 517, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "log_level", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "info" - }, - { - "type": "literal", - "value": "debug" - }, - { - "type": "literal", - "value": "warn" - }, - { - "type": "literal", - "value": "error" - } - ] - } - }, - { - "id": 518, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 33, - "character": 2 + "line": 66, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L66" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 526, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 38, - "character": 11 - } - ], - "indexSignature": { - "id": 528, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { "id": 521, - "name": "reconnectAfterMs", + "name": "encode", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, - "character": 2 + "line": 65, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L65" } ], "type": { "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } }, { - "id": 516, - "name": "timeout", + "id": 534, + "name": "fetch", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, - "character": 2 + "line": 73, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L73" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "Fetch" + }, + "name": "Fetch", + "package": "@supabase/realtime-js" + } + }, + { + "id": 524, + "name": "headers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 525, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "indexSignatures": [ + { + "id": 526, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 68, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L68" + } + ], + "parameters": [ + { + "id": 527, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + }, + { + "id": 519, + "name": "heartbeatIntervalMs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 63, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L63" } ], "type": { @@ -35961,38 +7483,239 @@ } }, { - "id": 515, - "name": "transport", + "id": 532, + "name": "log_level", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, - "character": 2 + "line": 71, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L71" } ], "type": { "type": "reference", - "name": "WebSocketLikeConstructor" + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "LogLevel" + }, + "name": "LogLevel", + "package": "@supabase/realtime-js" } }, { - "id": 532, - "name": "worker", + "id": 520, + "name": "logger", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 41, - "character": 2 + "line": 64, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L64" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 533, + "name": "logLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L72" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "LogLevel" + }, + "name": "LogLevel", + "package": "@supabase/realtime-js" + } + }, + { + "id": 528, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 529, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "indexSignatures": [ + { + "id": 530, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 69, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L69" + } + ], + "parameters": [ + { + "id": 531, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + }, + { + "id": 523, + "name": "reconnectAfterMs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L67" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 518, + "name": "timeout", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 62, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L62" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 517, + "name": "transport", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 61, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L61" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "name": "WebSocketLikeConstructor", + "package": "@supabase/realtime-js" + } + }, + { + "id": 535, + "name": "worker", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L74" } ], "type": { @@ -36001,18 +7724,81 @@ } }, { - "id": 533, + "id": 536, "name": "workerUrl", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 42, - "character": 2 + "line": 75, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L75" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 537, 522, 521, 534, 524, 519, 532, 520, 533, 528, 523, 518, 517, 535, 536 + ] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 60, + "character": 36, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L60" + } + ] + } + } + }, + { + "id": 540, + "name": "RealtimeMessage", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 32, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L32" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 541, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 543, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 34, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L34" } ], "type": { @@ -36021,107 +7807,57 @@ } }, { - "id": 534, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 546, + "name": "join_ref", + "variant": "declaration", + "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 43, - "character": 2 + "line": 37, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L37" } ], - "signatures": [ - { - "id": 535, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533] + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "title": "Methods", - "kind": 2048, - "children": [534] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 29, - "character": 36 - } - ] - } - } - }, - { - "id": 536, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 539, - "name": "event", + "id": 544, + "name": "payload", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 48, - "character": 2 + "line": 35, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L35" + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 545, + "name": "ref", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 36, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L36" } ], "type": { @@ -36131,71 +7867,16 @@ }, { "id": 542, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 541, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, "name": "topic", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 47, - "character": 2 + "line": 33, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L33" } ], "type": { @@ -36207,49 +7888,51 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [539, 542, 540, 541, 538] + "children": [543, 546, 544, 545, 542] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 46, - "character": 30 + "line": 32, + "character": 30, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L32" } ] } } }, { - "id": 543, + "id": 547, "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 67, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L67" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 549, + "id": 553, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 619, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" + "target": 623, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "package": "@supabase/realtime-js" }, "" ] @@ -36260,51 +7943,64 @@ "type": { "type": "reflection", "declaration": { - "id": 544, + "id": 548, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 545, + "id": 549, "name": "event", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of database change to listen to." + "summary": [ + { + "kind": "text", + "text": "The type of database change to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 73, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L73" } ], "type": { "type": "reference", - "id": 549, + "target": 553, "name": "T", - "dereferenced": {} + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 548, + "id": 552, "name": "filter", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Receive database changes when filter is matched." + "summary": [ + { + "kind": "text", + "text": "Receive database changes when filter is matched." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 85, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L85" } ], "type": { @@ -36313,19 +8009,25 @@ } }, { - "id": 546, + "id": 550, "name": "schema", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "comment": { - "shortText": "The database schema to listen to." + "summary": [ + { + "kind": "text", + "text": "The database schema to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 77, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L77" } ], "type": { @@ -36334,21 +8036,27 @@ } }, { - "id": 547, + "id": 551, "name": "table", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "The database table to listen to." + "summary": [ + { + "kind": "text", + "text": "The database table to listen to." + } + ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 81, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L81" } ], "type": { @@ -36360,78 +8068,91 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [545, 548, 546, 547] + "children": [549, 552, 550, 551] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 69, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L69" } ] } } }, { - "id": 550, + "id": 554, "name": "RealtimePostgresChangesPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 554, + "id": 555, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 551, + "id": 556, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, - "character": 53 + "character": 53, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } ], - "indexSignature": { - "id": 552, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 553, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 557, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 62, + "character": 55, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L62" } + ], + "parameters": [ + { + "id": 558, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -36440,598 +8161,124 @@ "type": "union", "types": [ { - "id": 555, + "type": "reference", + "target": 559, + "typeArguments": [ + { + "type": "reference", + "target": 555, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 41, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 564, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 561, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 41, - "character": 52 - } - ], - "indexSignature": { - "id": 562, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 563, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 557, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 621, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "" - ] - ] - } - }, - { - "id": 558, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 564, - "name": "T" - } - }, - { - "id": 559, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 560, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 45, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [557, 558, 559] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 42, - "character": 39 - } - ] - } - } - ] - } + "package": "@supabase/realtime-js" }, { - "id": 565, + "type": "reference", + "target": 569, + "typeArguments": [ + { + "type": "reference", + "target": 555, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 48, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 573, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 570, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 48, - "character": 52 - } - ], - "indexSignature": { - "id": 571, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 572, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 566, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 567, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 50, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 622, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "" - ] - ] - } - }, - { - "id": 568, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 51, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 573, - "name": "T" - } - }, - { - "id": 569, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 573, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [567, 568, 569] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 49, - "character": 39 - } - ] - } - } - ] - } + "package": "@supabase/realtime-js" }, { - "id": 574, - "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ + "type": "reference", + "target": 578, + "typeArguments": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 55, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 583, + "type": "reference", + "target": 555, "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 580, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 55, - "character": 52 - } - ], - "indexSignature": { - "id": 581, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 582, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 575, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 576, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 57, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 623, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "" - ] - ] - } - }, - { - "id": 577, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 578, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 58, - "character": 9 - } - ] - } - } - }, - { - "id": 579, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 59, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 583, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [576, 577, 579] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 56, - "character": 39 - } - ] - } - } - ] - } + "name": "RealtimePostgresDeletePayload", + "package": "@supabase/realtime-js" } ] } }, { - "id": 574, + "id": 578, "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 55, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 583, + "id": 584, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 585, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 55, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } ], - "indexSignature": { - "id": 581, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 582, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 586, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 55, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L55" } + ], + "parameters": [ + { + "id": 587, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -37041,39 +8288,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 575, + "id": 579, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 576, + "id": 580, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 57, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L57" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 623, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + "target": 627, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", + "package": "@supabase/realtime-js" }, "" ] @@ -37081,76 +8335,84 @@ } }, { - "id": 577, + "id": 581, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 58, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L58" } ], "type": { "type": "reflection", "declaration": { - "id": 578, + "id": 582, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 58, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L58" } ] } } }, { - "id": 579, + "id": 583, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 59, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L59" } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, "typeArguments": [ { "type": "reference", - "id": 583, - "name": "T" + "target": 584, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "name": "Partial", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [576, 577, 579] + "children": [580, 581, 583] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 56, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L56" } ] } @@ -37159,63 +8421,76 @@ } }, { - "id": 555, + "id": 559, "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 41, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 564, + "id": 565, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 561, + "id": 566, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 41, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } ], - "indexSignature": { - "id": 562, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 563, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 567, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 41, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L41" } + ], + "parameters": [ + { + "id": 568, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -37225,39 +8500,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 556, + "id": 560, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 557, + "id": 561, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L43" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 621, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + "target": 625, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", + "package": "@supabase/realtime-js" }, "" ] @@ -37265,50 +8547,55 @@ } }, { - "id": 558, + "id": 562, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L44" } ], "type": { "type": "reference", - "id": 564, - "name": "T" + "target": 565, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 559, + "id": 563, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L45" } ], "type": { "type": "reflection", "declaration": { - "id": 560, + "id": 564, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L45" } ] } @@ -37318,15 +8605,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [557, 558, 559] + "children": [561, 562, 563] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 42, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L42" } ] } @@ -37335,63 +8622,76 @@ } }, { - "id": 565, + "id": 569, "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 48, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 573, + "id": 574, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 570, + "id": 575, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 48, - "character": 52 + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } ], - "indexSignature": { - "id": 571, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 572, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 576, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 54, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L48" } + ], + "parameters": [ + { + "id": 577, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } + ] } } } @@ -37401,39 +8701,46 @@ "types": [ { "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" + "target": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayloadBase" + }, + "name": "RealtimePostgresChangesPayloadBase", + "package": "@supabase/realtime-js" }, { "type": "reflection", "declaration": { - "id": 566, + "id": 570, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "children": [ { - "id": 567, + "id": 571, "name": "eventType", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 50, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L50" } ], "type": { - "type": "template-literal", + "type": "templateLiteral", "head": "", "tail": [ [ { "type": "reference", - "id": 622, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + "target": 626, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", + "package": "@supabase/realtime-js" }, "" ] @@ -37441,64 +8748,73 @@ } }, { - "id": 568, + "id": 572, "name": "new", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 51, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L51" } ], "type": { "type": "reference", - "id": 573, - "name": "T" + "target": 574, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } }, { - "id": 569, + "id": 573, "name": "old", + "variant": "declaration", "kind": 1024, - "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 52, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L52" } ], "type": { "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, "typeArguments": [ { "type": "reference", - "id": 573, - "name": "T" + "target": 574, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true } ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "name": "Partial", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [567, 568, 569] + "children": [571, 572, 573] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 49, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L49" } ] } @@ -37507,460 +8823,74 @@ } }, { - "id": 584, + "id": 588, "name": "RealtimePresenceJoinPayload", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 593, + "id": 594, "name": "T", + "variant": "typeParam", "kind": 131072, - "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 590, + "id": 595, "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, - "character": 50 + "character": 50, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } ], - "indexSignature": { - "id": 591, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 592, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 596, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 21, + "character": 52, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" } + ], + "parameters": [ + { + "id": 597, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 588, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 593, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 586, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 626, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "" - ] - ] - } - }, - { - "id": 587, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "newPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 593, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [588, 586, 587, 589] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 21, - "character": 76 - } - ] - } - } - }, - { - "id": 594, - "name": "RealtimePresenceLeavePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 603, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 600, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 51 - } - ], - "indexSignature": { - "id": 601, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 602, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 598, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 603, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 596, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 627, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "" - ] - ] - } - }, - { - "id": 597, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 599, - "name": "leftPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 603, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [598, 596, 597, 599] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 28, - "character": 77 - } - ] - } - } - }, - { - "id": 604, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 612, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 609, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 610, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 611, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 17, - "character": 69 } ] } @@ -37970,65 +8900,549 @@ "type": { "type": "reflection", "declaration": { - "id": 605, + "id": 589, "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 592, + "name": "currentPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 24, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L24" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 594, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + }, + { + "id": 590, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L22" + } + ], + "type": { + "type": "templateLiteral", + "head": "", + "tail": [ + [ + { + "type": "reference", + "target": 630, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", + "package": "@supabase/realtime-js" + }, + "" + ] + ] + } + }, + { + "id": 591, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L23" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 593, + "name": "newPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 25, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L25" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 594, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [592, 590, 591, 593] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 21, + "character": 76, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L21" + } + ] + } + } + }, + { + "id": 598, + "name": "RealtimePresenceLeavePayload", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "typeParameters": [ + { + "id": 604, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 605, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 51, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "indexSignatures": [ + { + "id": 606, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 53, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ], + "parameters": [ + { + "id": 607, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 599, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 602, + "name": "currentPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 31, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L31" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 604, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + }, + { + "id": 600, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 29, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L29" + } + ], + "type": { + "type": "templateLiteral", + "head": "", + "tail": [ + [ + { + "type": "reference", + "target": 631, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", + "package": "@supabase/realtime-js" + }, + "" + ] + ] + } + }, + { + "id": 601, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 30, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L30" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 603, + "name": "leftPresences", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 32, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L32" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 604, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [602, 600, 601, 603] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 28, + "character": 77, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L28" + } + ] + } + } + }, + { + "id": 608, + "name": "RealtimePresenceState", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "typeParameters": [ + { + "id": 612, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 613, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 44, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "indexSignatures": [ + { + "id": 614, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 46, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ], + "parameters": [ + { + "id": 615, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 616, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 17, + "character": 69, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 609, + "name": "__type", + "variant": "declaration", "kind": 65536, - "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, - "character": 75 + "character": 75, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L17" } ], - "indexSignature": { - "id": 606, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "indexSignatures": [ + { + "id": 610, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimePresence.ts#L18" + } + ], + "parameters": [ + { + "id": 611, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "Presence" + }, + "typeArguments": [ + { + "type": "reference", + "target": 612, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "Presence", + "package": "@supabase/realtime-js" } } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "T" - } - ], - "name": "Presence" - } } - } + ] } } }, { - "id": 613, + "id": 617, "name": "RealtimeRemoveChannelResponse", - "kind": 4194304, - "kindString": "Type alias", + "variant": "declaration", + "kind": 2097152, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 54, - "character": 12 + "line": 40, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeClient.ts#L40" } ], "type": { @@ -38050,10 +9464,10 @@ } }, { - "id": 633, + "id": 637, "name": "REALTIME_CHANNEL_STATES", + "variant": "declaration", "kind": 32, - "kindString": "Variable", "flags": { "isConst": true }, @@ -38061,14 +9475,21 @@ { "fileName": "src/RealtimeChannel.ts", "line": 111, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/527f3fb92e2d3a37544bdbecac3646db0f78dd6f/src/RealtimeChannel.ts#L111" } ], "type": { "type": "query", "queryType": { "type": "reference", - "name": "CHANNEL_STATES" + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CHANNEL_STATES" + }, + "name": "CHANNEL_STATES", + "package": "@supabase/realtime-js", + "preferValues": true } }, "defaultValue": "CHANNEL_STATES" @@ -38077,30 +9498,1904 @@ "groups": [ { "title": "Enumerations", - "kind": 8, - "children": [614, 619, 624, 628] + "children": [618, 623, 628, 632] }, { "title": "Classes", - "kind": 128, - "children": [64, 371, 1] + "children": [65, 372, 1] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [358, 370, 513, 536, 543, 550, 574, 555, 565, 584, 594, 604, 613] + "children": [359, 371, 515, 540, 547, 554, 578, 559, 569, 588, 598, 608, 617] }, { "title": "Variables", - "kind": 32, - "children": [633] + "children": [637] } ], - "sources": [ + "packageName": "@supabase/realtime-js", + "readme": [ { - "fileName": "src/index.ts", - "line": 1, - "character": 0 + "kind": "text", + "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" + }, + { + "kind": "code", + "text": "```bash\nnpm install @supabase/realtime-js\n```" + }, + { + "kind": "text", + "text": "\n\n## Creating a Channel\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { RealtimeClient } from '@supabase/realtime-js'\n\nconst client = new RealtimeClient(REALTIME_URL, {\n params: {\n apikey: API_KEY\n },\n})\n\nconst channel = client.channel('test-channel', {})\n\nchannel.subscribe((status, err) => {\n if (status === 'SUBSCRIBED') {\n console.log('Connected!')\n }\n\n if (status === 'CHANNEL_ERROR') {\n console.log(`There was an error subscribing to channel: ${err.message}`)\n }\n\n if (status === 'TIMED_OUT') {\n console.log('Realtime server did not respond in time.')\n }\n\n if (status === 'CLOSED') {\n console.log('Realtime channel was unexpectedly closed.')\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n### Notes:\n\n- " + }, + { + "kind": "code", + "text": "`REALTIME_URL`" + }, + { + "kind": "text", + "text": " is " + }, + { + "kind": "code", + "text": "`'ws://localhost:4000/socket'`" + }, + { + "kind": "text", + "text": " when developing locally and " + }, + { + "kind": "code", + "text": "`'wss://.supabase.co/realtime/v1'`" + }, + { + "kind": "text", + "text": " when connecting to your Supabase project.\n- " + }, + { + "kind": "code", + "text": "`API_KEY`" + }, + { + "kind": "text", + "text": " is a JWT whose claims must contain " + }, + { + "kind": "code", + "text": "`exp`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " (existing database role).\n- Channel name can be any " + }, + { + "kind": "code", + "text": "`string`" + }, + { + "kind": "text", + "text": ".\n\n## Broadcast\n\nYour client can send and receive messages based on the " + }, + { + "kind": "code", + "text": "`event`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n### Notes:\n\n- Setting " + }, + { + "kind": "code", + "text": "`ack`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the " + }, + { + "kind": "code", + "text": "`channel.send`" + }, + { + "kind": "text", + "text": " promise will resolve once server replies with acknowledgement that it received the broadcast message request.\n- Setting " + }, + { + "kind": "code", + "text": "`self`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the client will receive the broadcast message it sent out.\n- Setting " + }, + { + "kind": "code", + "text": "`private`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " means that the client will use RLS to determine if the user can connect or not to a given channel.\n\n## Presence\n\nYour client can track and sync state that's stored in the channel.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel(\n 'presence-test',\n {\n config: {\n presence: {\n key: ''\n }\n }\n }\n)\n\nchannel.on('presence', { event: 'sync' }, () => {\n console.log('Online users: ', channel.presenceState())\n})\n\nchannel.on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('New users have joined: ', newPresences)\n})\n\nchannel.on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Users have left: ', leftPresences)\n})\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n const status = await channel.track({ 'user_id': 1 })\n console.log(status)\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n## Postgres CDC\n\nReceive database changes on the client.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('db-changes')\n\nchannel.on('postgres_changes', { event: '*', schema: 'public' }, (payload) => {\n console.log('All changes in public schema: ', payload)\n})\n\nchannel.on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'messages' }, (payload) => {\n console.log('All inserts in messages table: ', payload)\n})\n\nchannel.on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' }, (payload) => {\n console.log('All updates on users table when username is Realtime: ', payload)\n})\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n console.log('Ready to receive database changes!')\n }\n})\n```" + }, + { + "kind": "text", + "text": "\n\n## Get All Channels\n\nYou can see all the channels that your client has instantiatied.\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nclient.getChannels()\n```" + }, + { + "kind": "text", + "text": "\n\n## Cleanup\n\nIt is highly recommended that you clean up your channels after you're done with them.\n\n- Remove a single channel\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel = client.channel('some-channel-to-remove')\n\nchannel.subscribe()\n\nclient.removeChannel(channel)\n```" + }, + { + "kind": "text", + "text": "\n\n- Remove all channels\n\n" + }, + { + "kind": "code", + "text": "```js\n// Setup...\n\nconst channel1 = client.channel('a-channel-to-remove')\nconst channel2 = client.channel('another-channel-to-remove')\n\nchannel1.subscribe()\nchannel2.subscribe()\n\nclient.removeAllChannels()\n```" + }, + { + "kind": "text", + "text": "\n\n## Credits\n\nThis repo draws heavily from [phoenix-js](https://github.com/phoenixframework/phoenix/tree/master/assets/js/phoenix).\n\n## License\n\nMIT." } - ] + ], + "symbolIdMap": { + "0": { + "sourceFileName": "src/index.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default" + }, + "36": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.__constructor" + }, + "37": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default" + }, + "38": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "channel" + }, + "39": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "opts" + }, + "40": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.state" + }, + "41": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "42": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.pendingDiffs" + }, + "43": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.joinRef" + }, + "44": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.caller" + }, + "45": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "46": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onJoin" + }, + "47": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onLeave" + }, + "48": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.onSync" + }, + "49": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "50": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "51": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "default.channel" + }, + "65": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default" + }, + "76": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.__constructor" + }, + "77": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default" + }, + "78": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "topic" + }, + "79": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "params" + }, + "80": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "socket" + }, + "81": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.bindings" + }, + "82": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "83": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "85": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "86": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "87": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.filter" + }, + "88": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "89": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "91": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.callback" + }, + "92": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.id" + }, + "93": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.timeout" + }, + "94": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.state" + }, + "95": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.joinedOnce" + }, + "96": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.joinPush" + }, + "97": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.rejoinTimer" + }, + "98": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.pushBuffer" + }, + "99": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presence" + }, + "100": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.broadcastEndpointURL" + }, + "101": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subTopic" + }, + "102": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.private" + }, + "103": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.topic" + }, + "104": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.params" + }, + "105": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.socket" + }, + "106": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subscribe" + }, + "107": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.subscribe" + }, + "108": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "109": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "110": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "111": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "status" + }, + "112": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "err" + }, + "113": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "timeout" + }, + "114": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presenceState" + }, + "115": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.presenceState" + }, + "116": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "117": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "118": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "120": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "121": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.track" + }, + "122": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.track" + }, + "123": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "124": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "125": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "127": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "128": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "129": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "131": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.untrack" + }, + "132": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.untrack" + }, + "133": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "134": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "135": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "137": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "138": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "139": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "140": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "141": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "142": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "143": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "144": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "145": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "146": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "147": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "148": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "149": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "151": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "152": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "153": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "154": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "155": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "156": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "157": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "158": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "159": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "160": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "161": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "162": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "164": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "165": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "166": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "167": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "168": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "169": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "170": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "171": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "172": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "173": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "174": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "175": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "177": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "178": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "179": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "180": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "181": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "182": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "183": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "184": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "185": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "186": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "188": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "189": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "190": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "191": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "192": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "193": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "194": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "195": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "196": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "197": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "199": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "200": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "201": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "202": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "203": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "204": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "205": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "206": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "207": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "208": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "210": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "211": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "212": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "213": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "214": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "215": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "216": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "217": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "218": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "219": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "220": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "221": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "222": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "223": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "224": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "225": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "226": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "227": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "228": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "230": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "231": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "232": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "233": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "235": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "236": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "237": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "238": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "239": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "240": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "241": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "242": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "243": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "244": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "245": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "246": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.payload" + }, + "247": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.on" + }, + "248": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "249": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "250": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "252": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "type" + }, + "253": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "filter" + }, + "254": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "255": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "callback" + }, + "256": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "257": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "258": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "259": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.send" + }, + "260": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.send" + }, + "261": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "args" + }, + "262": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "263": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.type" + }, + "264": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "265": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.payload" + }, + "266": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "268": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "opts" + }, + "269": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "270": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "272": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.updateJoinPayload" + }, + "273": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.updateJoinPayload" + }, + "274": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "payload" + }, + "275": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "276": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "278": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.unsubscribe" + }, + "279": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "default.unsubscribe" + }, + "280": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "timeout" + }, + "359": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimeChannelOptions" + }, + "360": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "361": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.config" + }, + "362": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "363": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.broadcast" + }, + "364": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "365": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.self" + }, + "366": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.ack" + }, + "367": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.presence" + }, + "368": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "369": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.key" + }, + "370": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.private" + }, + "371": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimeChannelSendResponse" + }, + "372": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default" + }, + "373": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.__constructor" + }, + "374": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default" + }, + "375": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "endPoint" + }, + "376": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "options" + }, + "377": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.accessTokenValue" + }, + "378": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.apiKey" + }, + "379": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channels" + }, + "380": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endPoint" + }, + "381": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.httpEndpoint" + }, + "382": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.headers" + }, + "383": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "384": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "386": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.params" + }, + "387": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "388": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "390": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.timeout" + }, + "391": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.transport" + }, + "392": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.heartbeatIntervalMs" + }, + "393": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.heartbeatTimer" + }, + "394": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.pendingHeartbeatRef" + }, + "395": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.ref" + }, + "396": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.reconnectTimer" + }, + "397": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.logger" + }, + "398": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.logLevel" + }, + "399": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.encode" + }, + "400": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.decode" + }, + "401": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.reconnectAfterMs" + }, + "402": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.conn" + }, + "403": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendBuffer" + }, + "404": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.serializer" + }, + "405": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.stateChangeCallbacks" + }, + "406": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "407": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.open" + }, + "408": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.close" + }, + "409": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.error" + }, + "410": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.message" + }, + "411": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.fetch" + }, + "412": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "fetch" + }, + "413": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "fetch" + }, + "414": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "input" + }, + "415": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "init" + }, + "416": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "fetch" + }, + "417": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "input" + }, + "418": { + "sourceFileName": "node_modules/@types/node/globals.d.ts", + "qualifiedName": "init" + }, + "419": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.accessToken" + }, + "420": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "421": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "422": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.worker" + }, + "423": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.workerUrl" + }, + "424": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.workerRef" + }, + "425": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connect" + }, + "426": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connect" + }, + "427": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endpointURL" + }, + "428": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.endpointURL" + }, + "429": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.disconnect" + }, + "430": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.disconnect" + }, + "431": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "code" + }, + "432": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "reason" + }, + "433": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.getChannels" + }, + "434": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.getChannels" + }, + "435": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeChannel" + }, + "436": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeChannel" + }, + "437": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "channel" + }, + "438": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeAllChannels" + }, + "439": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.removeAllChannels" + }, + "440": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.log" + }, + "441": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.log" + }, + "442": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "kind" + }, + "443": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "msg" + }, + "444": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "data" + }, + "445": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connectionState" + }, + "446": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.connectionState" + }, + "447": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnected" + }, + "448": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnected" + }, + "449": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channel" + }, + "450": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.channel" + }, + "451": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "topic" + }, + "452": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "params" + }, + "453": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.push" + }, + "454": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.push" + }, + "455": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "data" + }, + "456": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.setAuth" + }, + "457": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.setAuth" + }, + "458": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "token" + }, + "459": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendHeartbeat" + }, + "460": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.sendHeartbeat" + }, + "461": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.flushSendBuffer" + }, + "462": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.flushSendBuffer" + }, + "515": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeClientOptions" + }, + "516": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "517": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.transport" + }, + "518": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.timeout" + }, + "519": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.heartbeatIntervalMs" + }, + "520": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.logger" + }, + "521": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.encode" + }, + "522": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.decode" + }, + "523": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.reconnectAfterMs" + }, + "524": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.headers" + }, + "525": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "526": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "528": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.params" + }, + "529": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "530": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.__index" + }, + "532": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.log_level" + }, + "533": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.logLevel" + }, + "534": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.fetch" + }, + "535": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.worker" + }, + "536": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.workerUrl" + }, + "537": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.accessToken" + }, + "538": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "539": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "540": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeMessage" + }, + "541": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "542": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.topic" + }, + "543": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.event" + }, + "544": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.payload" + }, + "545": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.ref" + }, + "546": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.join_ref" + }, + "547": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesFilter" + }, + "548": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "549": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.event" + }, + "550": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.schema" + }, + "551": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.table" + }, + "552": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.filter" + }, + "553": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "554": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresChangesPayload" + }, + "555": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "556": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "557": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "559": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresInsertPayload" + }, + "560": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "561": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "562": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "563": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "564": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "565": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "566": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "567": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "569": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresUpdatePayload" + }, + "570": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "571": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "572": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "573": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "574": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "575": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "576": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "578": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "RealtimePostgresDeletePayload" + }, + "579": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "580": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.eventType" + }, + "581": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.new" + }, + "582": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "583": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.old" + }, + "584": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "T" + }, + "585": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type" + }, + "586": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "__type.__index" + }, + "588": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceJoinPayload" + }, + "589": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "590": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.event" + }, + "591": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.key" + }, + "592": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.currentPresences" + }, + "593": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.newPresences" + }, + "594": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "595": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "596": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "598": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceLeavePayload" + }, + "599": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "600": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.event" + }, + "601": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.key" + }, + "602": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.currentPresences" + }, + "603": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.leftPresences" + }, + "604": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "605": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "606": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "608": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RealtimePresenceState" + }, + "609": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "610": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "612": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "T" + }, + "613": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "614": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type.__index" + }, + "616": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "__type" + }, + "617": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "RealtimeRemoveChannelResponse" + }, + "618": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES" + }, + "619": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" + }, + "620": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" + }, + "621": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" + }, + "622": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" + }, + "623": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" + }, + "624": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" + }, + "625": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + }, + "626": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + }, + "627": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + }, + "628": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" + }, + "629": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" + }, + "630": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" + }, + "631": { + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" + }, + "632": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES" + }, + "633": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" + }, + "634": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" + }, + "635": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" + }, + "636": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" + }, + "637": { + "sourceFileName": "src/RealtimeChannel.ts", + "qualifiedName": "REALTIME_CHANNEL_STATES" + } + }, + "files": { + "entries": { + "1": "src/index.ts" + }, + "reflections": { + "1": 0 + } + } } diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json index 853eed28c1e..69bfa0e3b1a 100644 --- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json +++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json @@ -4759,6 +4759,376 @@ ] } }, + "/v1/projects/{ref}/config/auth/signing-keys": { + "post": { + "operationId": "createSigningKeyForProject", + "summary": "[Alpha] Create a new signing key for the project in standby status", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "standby"] + } + }, + "required": ["algorithm"], + "additionalProperties": false + } + } + } + }, + "responses": { + "201": { + "description": "[Alpha] Create a new signing key for the project in standby status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "standby"] + } + }, + "required": ["algorithm"], + "additionalProperties": false + } + } + } + }, + "403": { + "description": "" + } + }, + "tags": ["Auth"], + "security": [ + { + "bearer": [] + } + ] + }, + "get": { + "operationId": "listSigningKeysForProject", + "summary": "[Alpha] List all signing keys for the project", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "keys": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + } + } + }, + "required": ["keys"], + "additionalProperties": false + } + } + } + }, + "403": { + "description": "" + } + }, + "tags": ["Auth"], + "security": [ + { + "bearer": [] + } + ] + } + }, + "/v1/projects/{ref}/config/auth/signing-keys/{id}": { + "get": { + "operationId": "getSigningKeyForProject", + "summary": "[Alpha] Get information about a signing key", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + } + } + } + } + }, + "tags": ["Auth"], + "security": [ + { + "bearer": [] + } + ] + }, + "delete": { + "operationId": "deleteSigningKey", + "summary": "[Alpha] Remove a signing key from a project, where the status is previously_used", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + } + } + } + }, + "403": { + "description": "" + } + }, + "tags": ["Auth"], + "security": [ + { + "bearer": [] + } + ] + }, + "patch": { + "operationId": "patchSigningKey", + "summary": "[Alpha] Update a signing key, mainly its status", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + } + }, + "required": ["status"], + "additionalProperties": false + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + } + } + } + }, + "403": { + "description": "" + } + }, + "tags": ["Auth"], + "security": [ + { + "bearer": [] + } + ] + } + }, "/v1/projects/{ref}/config/storage": { "get": { "operationId": "v1-get-storage-config", @@ -12288,6 +12658,9 @@ "value": { "type": "string" }, + "updated_at": { + "type": "string" + }, "updated_at": { "type": "string" } @@ -12739,6 +13112,102 @@ }, "required": ["name", "healthy", "status"] }, + "CreateSigningKeyBody": { + "type": "object", + "properties": { + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "standby"] + } + }, + "required": ["algorithm"], + "additionalProperties": false + }, + "SigningKeysResponse": { + "type": "object", + "properties": { + "keys": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + } + } + }, + "required": ["keys"], + "additionalProperties": false + }, + "SigningKeyResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "algorithm": { + "type": "string", + "enum": ["EdDSA", "ES256", "RS256", "HS256"] + }, + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + }, + "public_jwk": { + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": ["id", "algorithm", "status", "created_at", "updated_at"], + "additionalProperties": false + }, + "UpdateSigningKeyBody": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["in_use", "previously_used", "revoked", "standby"] + } + }, + "required": ["status"], + "additionalProperties": false + }, "StorageFeatureImageTransformation": { "type": "object", "properties": { From 02fe57e8b906b265281a2cd9b5fab73a5d2d4eed Mon Sep 17 00:00:00 2001 From: Tyler Date: Tue, 4 Mar 2025 07:05:49 +0900 Subject: [PATCH 14/50] docs: Update MCP docs for connecting to Cursor (#33952) * docs: Update MCP docs for connecting to Cursor * minor fix --- .../content/guides/getting-started/mcp.mdx | 24 ++++++++++++------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/apps/docs/content/guides/getting-started/mcp.mdx b/apps/docs/content/guides/getting-started/mcp.mdx index 49691b960a7..713d10e6df4 100644 --- a/apps/docs/content/guides/getting-started/mcp.mdx +++ b/apps/docs/content/guides/getting-started/mcp.mdx @@ -67,17 +67,25 @@ Below are some ways to connect to the Postgres MCP server using popular AI tools #### Cursor -1. Open Cursor and navigate to **Cursor Settings**. -1. Under the **Features** tab, tap **+ Add new MCP server** under the **MCP Servers** section. -1. Enter the following details: +1. Open Cursor and open `.cursor/mcp.json` file. Create the file if it doesn't exist. +1. Add the following configuration: - - **Name**: Supabase (or your project name) - - **Type**: command - - **Command**: `npx -y @modelcontextprotocol/server-postgres ` + ```json + { + "mcpServers": { + "supabase": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-postgres", ""] + } + } + } + ``` - (replace `` with your connection string) + Replace `` with your connection string. -1. You should see a green active status after the server is successfully connected. +1. Save the configuration file. + +1. Open Cursor and navigate to **Settings/MCP**. You should see a green active status after the server is successfully connected. #### Claude desktop From 326d2cbdcb8b429767dadb68a1d1c63fd44137a9 Mon Sep 17 00:00:00 2001 From: Saxon Fletcher Date: Tue, 4 Mar 2025 09:58:25 +1000 Subject: [PATCH 15/50] Update authentication advanced page (#33955) * init PrePostTab component * init * support auto fixing rounded of inputs/select/textarea * remove form item layout prepost * Update FormLayout.tsx * Update FormLayout.tsx * Update FormLayout.tsx * form layout and advanced * Update advanced.tsx * protection and hooks * fix * parse --------- Co-authored-by: Jonathan Summers-Muir --- .../Auth/AdvancedAuthSettingsForm.tsx | 262 +++++++++------ .../interfaces/Auth/Hooks/HooksListing.tsx | 10 +- .../ProtectionAuthSettingsForm.tsx | 308 ++++++++++-------- .../pages/project/[ref]/auth/advanced.tsx | 66 ++-- .../studio/pages/project/[ref]/auth/hooks.tsx | 61 ++-- .../pages/project/[ref]/auth/protection.tsx | 74 +++-- .../ui-patterns/form/Layout/FormLayout.tsx | 4 +- packages/ui/index.tsx | 2 + .../src/components/PrePostTab/PrePostTab.tsx | 36 ++ .../ui/src/components/PrePostTab/index.tsx | 2 + 10 files changed, 513 insertions(+), 312 deletions(-) create mode 100644 packages/ui/src/components/PrePostTab/PrePostTab.tsx create mode 100644 packages/ui/src/components/PrePostTab/index.tsx diff --git a/apps/studio/components/interfaces/Auth/AdvancedAuthSettingsForm.tsx b/apps/studio/components/interfaces/Auth/AdvancedAuthSettingsForm.tsx index 20381650218..dbbb01898b8 100644 --- a/apps/studio/components/interfaces/Auth/AdvancedAuthSettingsForm.tsx +++ b/apps/studio/components/interfaces/Auth/AdvancedAuthSettingsForm.tsx @@ -1,15 +1,12 @@ import { zodResolver } from '@hookform/resolvers/zod' import { PermissionAction } from '@supabase/shared-types/out/constants' -import { useEffect, useMemo } from 'react' -import { SubmitHandler, useForm } from 'react-hook-form' +import { useEffect, useState } from 'react' +import { useForm } from 'react-hook-form' import { toast } from 'sonner' import * as z from 'zod' import { useParams } from 'common' -import { StringNumberOrNull } from 'components/ui/Forms/Form.constants' -import { FormActions } from 'components/ui/Forms/FormActions' -import { FormPanel } from 'components/ui/Forms/FormPanel' -import { FormSection, FormSectionContent, FormSectionLabel } from 'components/ui/Forms/FormSection' +import { ScaffoldSection, ScaffoldSectionTitle } from 'components/layouts/Scaffold' import NoPermission from 'components/ui/NoPermission' import UpgradeToPro from 'components/ui/UpgradeToPro' import { useAuthConfigQuery } from 'data/auth/auth-config-query' @@ -22,15 +19,19 @@ import { AlertDescription_Shadcn_, AlertTitle_Shadcn_, Alert_Shadcn_, + Button, + Card, + CardContent, + CardFooter, FormControl_Shadcn_, FormField_Shadcn_, Form_Shadcn_, Input_Shadcn_, + PrePostTab, WarningIcon, } from 'ui' import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout' - -const formId = 'auth-config-advanced-form' +import { StringNumberOrNull } from 'components/ui/Forms/Form.constants' const FormSchema = z.object({ API_MAX_REQUEST_DURATION: z.coerce @@ -46,69 +47,110 @@ export const AdvancedAuthSettingsForm = () => { const canReadConfig = useCheckPermissions(PermissionAction.READ, 'custom_config_gotrue') const canUpdateConfig = useCheckPermissions(PermissionAction.UPDATE, 'custom_config_gotrue') + const [isUpdatingRequestDurationForm, setIsUpdatingRequestDurationForm] = useState(false) + const [isUpdatingDatabaseForm, setIsUpdatingDatabaseForm] = useState(false) + const { data: authConfig, error: authConfigError, isLoading, isError, - isSuccess, } = useAuthConfigQuery({ projectRef }) const { data: subscription, isSuccess: isSuccessSubscription } = useOrgSubscriptionQuery({ orgSlug: organization?.slug, }) - const { mutate: updateAuthConfig, isLoading: isUpdatingConfig } = useAuthConfigUpdateMutation() - - const defaultValues = useMemo( - () => ({ - API_MAX_REQUEST_DURATION: authConfig?.API_MAX_REQUEST_DURATION ?? undefined, - DB_MAX_POOL_SIZE: authConfig?.DB_MAX_POOL_SIZE ?? '', - }), - [authConfig] - ) - - const form = useForm>({ - resolver: zodResolver(FormSchema), - defaultValues: defaultValues as any, - }) - const { isDirty } = form.formState + const { mutate: updateAuthConfig } = useAuthConfigUpdateMutation() const isTeamsEnterprisePlan = - isSuccessSubscription && subscription.plan.id !== 'free' && subscription.plan.id !== 'pro' + isSuccessSubscription && subscription?.plan.id !== 'free' && subscription?.plan.id !== 'pro' const promptTeamsEnterpriseUpgrade = IS_PLATFORM && isSuccessSubscription && !isTeamsEnterprisePlan - const resetForm = () => { - form.reset(defaultValues as any) - } + const requestDurationForm = useForm({ + resolver: zodResolver( + z.object({ + API_MAX_REQUEST_DURATION: FormSchema.shape.API_MAX_REQUEST_DURATION, + }) + ), + defaultValues: { + API_MAX_REQUEST_DURATION: 10, + }, + }) - const onSubmit: SubmitHandler> = (data) => { - if (!projectRef) return console.error('Project ref is required') + const databaseForm = useForm({ + resolver: zodResolver( + z.object({ + DB_MAX_POOL_SIZE: FormSchema.shape.DB_MAX_POOL_SIZE, + }) + ), + defaultValues: { + DB_MAX_POOL_SIZE: '', + }, + }) - const { API_MAX_REQUEST_DURATION, DB_MAX_POOL_SIZE, ...config } = data - const payload = { - ...config, - ...(isTeamsEnterprisePlan ? { API_MAX_REQUEST_DURATION } : {}), - DB_MAX_POOL_SIZE, + useEffect(() => { + if (authConfig) { + if (!isUpdatingRequestDurationForm) { + requestDurationForm.reset({ + API_MAX_REQUEST_DURATION: authConfig?.API_MAX_REQUEST_DURATION ?? 10, + }) + } + + if (!isUpdatingDatabaseForm) { + databaseForm.reset({ + DB_MAX_POOL_SIZE: + authConfig?.DB_MAX_POOL_SIZE !== null ? String(authConfig?.DB_MAX_POOL_SIZE) : '', + }) + } } + }, [authConfig, isUpdatingRequestDurationForm, isUpdatingDatabaseForm]) + + const onSubmitRequestDurationForm = (values: any) => { + if (!projectRef) return console.error('Project ref is required') + if (!isTeamsEnterprisePlan) return + + setIsUpdatingRequestDurationForm(true) updateAuthConfig( - // @ts-expect-error - { projectRef: projectRef, config: payload }, + { projectRef: projectRef, config: values }, { + onError: (error) => { + toast.error(`Failed to update request duration settings: ${error?.message}`) + setIsUpdatingRequestDurationForm(false) + }, onSuccess: () => { - toast.success('Successfully updated settings') - form.reset({ ...defaultValues, ...data }) + toast.success('Successfully updated request duration settings') + setIsUpdatingRequestDurationForm(false) }, } ) } - useEffect(() => { - // reset form with the current values - if (isSuccess) resetForm() - }, [defaultValues, isSuccess]) + const onSubmitDatabaseForm = (values: any) => { + if (!projectRef) return console.error('Project ref is required') + + setIsUpdatingDatabaseForm(true) + + const config = { + DB_MAX_POOL_SIZE: values.DB_MAX_POOL_SIZE, + } + + updateAuthConfig( + { projectRef: projectRef, config }, + { + onError: (error) => { + toast.error(`Failed to update database connection settings: ${error?.message}`) + setIsUpdatingDatabaseForm(false) + }, + onSuccess: () => { + toast.success('Successfully updated database connection settings') + setIsUpdatingDatabaseForm(false) + }, + } + ) + } if (isError) { return ( @@ -127,88 +169,126 @@ export const AdvancedAuthSettingsForm = () => { return ( <> {promptTeamsEnterpriseUpgrade && ( - +
+ +
)} - -
- - resetForm()} - disabled={!canUpdateConfig} - helper={ - !canUpdateConfig - ? 'You need additional permissions to update authentication settings' - : undefined - } - /> -
- } + + Request Duration + + + - Max Request Duration}> - + + (
- - - seconds - + + +
)} /> - - + - Auth Database Connections}> - + + {requestDurationForm.formState.isDirty && ( + + )} + + + + + + + + + Auth Database Connections + + +
+ + ( )} /> - - - - -
+ + + + {databaseForm.formState.isDirty && ( + + )} + + + + + + ) } diff --git a/apps/studio/components/interfaces/Auth/Hooks/HooksListing.tsx b/apps/studio/components/interfaces/Auth/Hooks/HooksListing.tsx index f005bb73987..6b2937894e0 100644 --- a/apps/studio/components/interfaces/Auth/Hooks/HooksListing.tsx +++ b/apps/studio/components/interfaces/Auth/Hooks/HooksListing.tsx @@ -16,6 +16,7 @@ import { CreateHookSheet } from './CreateHookSheet' import { HookCard } from './HookCard' import { HOOKS_DEFINITIONS, HOOK_DEFINITION_TITLE, Hook } from './hooks.constants' import { extractMethod, getRevokePermissionStatements, isValidHook } from './hooks.utils' +import { ScaffoldSection, ScaffoldSectionTitle } from 'components/layouts/Scaffold' export const HooksListing = () => { const { ref: projectRef } = useParams() @@ -68,8 +69,11 @@ export const HooksListing = () => { } return ( -
- } /> + +
+ All hooks + +
{hooks.filter((h) => isValidHook(h)).length === 0 && (
{ )}
-
+ ) } diff --git a/apps/studio/components/interfaces/Auth/ProtectionAuthSettingsForm/ProtectionAuthSettingsForm.tsx b/apps/studio/components/interfaces/Auth/ProtectionAuthSettingsForm/ProtectionAuthSettingsForm.tsx index ce1aad4abbc..a0e3fe248f7 100644 --- a/apps/studio/components/interfaces/Auth/ProtectionAuthSettingsForm/ProtectionAuthSettingsForm.tsx +++ b/apps/studio/components/interfaces/Auth/ProtectionAuthSettingsForm/ProtectionAuthSettingsForm.tsx @@ -1,30 +1,40 @@ import { PermissionAction } from '@supabase/shared-types/out/constants' import { Eye, EyeOff } from 'lucide-react' import { useEffect, useState } from 'react' +import { useForm } from 'react-hook-form' import { toast } from 'sonner' import { boolean, number, object, string } from 'yup' +import { yupResolver } from '@hookform/resolvers/yup' import { useParams } from 'common' -import { FormActions } from 'components/ui/Forms/FormActions' -import { FormHeader } from 'components/ui/Forms/FormHeader' -import { FormPanel } from 'components/ui/Forms/FormPanel' -import { FormSection, FormSectionContent, FormSectionLabel } from 'components/ui/Forms/FormSection' +import { ScaffoldSection, ScaffoldSectionTitle } from 'components/layouts/Scaffold' import NoPermission from 'components/ui/NoPermission' import { useAuthConfigQuery } from 'data/auth/auth-config-query' import { useAuthConfigUpdateMutation } from 'data/auth/auth-config-update-mutation' import { useCheckPermissions } from 'hooks/misc/useCheckPermissions' +import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout' import { AlertDescription_Shadcn_, AlertTitle_Shadcn_, Alert_Shadcn_, Button, - Form, - Input, - Toggle, + Card, + CardContent, + CardFooter, + FormControl_Shadcn_, + FormField_Shadcn_, + Form_Shadcn_, + Input_Shadcn_, + Select_Shadcn_, + SelectContent_Shadcn_, + SelectItem_Shadcn_, + SelectTrigger_Shadcn_, + SelectValue_Shadcn_, + Switch, WarningIcon, + PrePostTab, } from 'ui' import { NO_REQUIRED_CHARACTERS } from '../Auth.constants' -import FormField from '../AuthProvidersForm/FormField' const schema = object({ DISABLE_SIGNUP: boolean().required(), @@ -51,8 +61,6 @@ const schema = object({ PASSWORD_HIBP_ENABLED: boolean(), }) -const formId = 'auth-config-protection-settings' - const ProtectionAuthSettingsForm = () => { const { ref: projectRef } = useParams() const { @@ -60,32 +68,57 @@ const ProtectionAuthSettingsForm = () => { error: authConfigError, isLoading, isError, - isSuccess, } = useAuthConfigQuery({ projectRef }) const { mutate: updateAuthConfig, isLoading: isUpdatingConfig } = useAuthConfigUpdateMutation() - + const [isUpdatingProtection, setIsUpdatingProtection] = useState(false) const [hidden, setHidden] = useState(true) + const canReadConfig = useCheckPermissions(PermissionAction.READ, 'custom_config_gotrue') const canUpdateConfig = useCheckPermissions(PermissionAction.UPDATE, 'custom_config_gotrue') - const INITIAL_VALUES = { - DISABLE_SIGNUP: !authConfig?.DISABLE_SIGNUP, - EXTERNAL_ANONYMOUS_USERS_ENABLED: authConfig?.EXTERNAL_ANONYMOUS_USERS_ENABLED, - SECURITY_MANUAL_LINKING_ENABLED: authConfig?.SECURITY_MANUAL_LINKING_ENABLED || false, - SITE_URL: authConfig?.SITE_URL, - SECURITY_CAPTCHA_ENABLED: authConfig?.SECURITY_CAPTCHA_ENABLED || false, - SECURITY_CAPTCHA_SECRET: authConfig?.SECURITY_CAPTCHA_SECRET || '', - SECURITY_CAPTCHA_PROVIDER: authConfig?.SECURITY_CAPTCHA_PROVIDER || 'hcaptcha', - SESSIONS_TIMEBOX: authConfig?.SESSIONS_TIMEBOX || 0, - SESSIONS_INACTIVITY_TIMEOUT: authConfig?.SESSIONS_INACTIVITY_TIMEOUT || 0, - SESSIONS_SINGLE_PER_USER: authConfig?.SESSIONS_SINGLE_PER_USER || false, - PASSWORD_MIN_LENGTH: authConfig?.PASSWORD_MIN_LENGTH || 6, - PASSWORD_REQUIRED_CHARACTERS: - authConfig?.PASSWORD_REQUIRED_CHARACTERS || NO_REQUIRED_CHARACTERS, - PASSWORD_HIBP_ENABLED: authConfig?.PASSWORD_HIBP_ENABLED || false, - } + const protectionForm = useForm({ + resolver: yupResolver(schema), + defaultValues: { + DISABLE_SIGNUP: true, + EXTERNAL_ANONYMOUS_USERS_ENABLED: false, + SECURITY_MANUAL_LINKING_ENABLED: false, + SITE_URL: '', + SECURITY_CAPTCHA_ENABLED: false, + SECURITY_CAPTCHA_SECRET: '', + SECURITY_CAPTCHA_PROVIDER: 'hcaptcha', + SESSIONS_TIMEBOX: 0, + SESSIONS_INACTIVITY_TIMEOUT: 0, + SESSIONS_SINGLE_PER_USER: false, + PASSWORD_MIN_LENGTH: 6, + PASSWORD_REQUIRED_CHARACTERS: NO_REQUIRED_CHARACTERS, + PASSWORD_HIBP_ENABLED: false, + }, + }) + + useEffect(() => { + if (authConfig && !isUpdatingProtection) { + protectionForm.reset({ + DISABLE_SIGNUP: !authConfig.DISABLE_SIGNUP, + EXTERNAL_ANONYMOUS_USERS_ENABLED: authConfig.EXTERNAL_ANONYMOUS_USERS_ENABLED || false, + SECURITY_MANUAL_LINKING_ENABLED: authConfig.SECURITY_MANUAL_LINKING_ENABLED || false, + SITE_URL: authConfig.SITE_URL || '', + SECURITY_CAPTCHA_ENABLED: authConfig.SECURITY_CAPTCHA_ENABLED || false, + SECURITY_CAPTCHA_SECRET: authConfig.SECURITY_CAPTCHA_SECRET || '', + SECURITY_CAPTCHA_PROVIDER: authConfig.SECURITY_CAPTCHA_PROVIDER || 'hcaptcha', + SESSIONS_TIMEBOX: authConfig.SESSIONS_TIMEBOX || 0, + SESSIONS_INACTIVITY_TIMEOUT: authConfig.SESSIONS_INACTIVITY_TIMEOUT || 0, + SESSIONS_SINGLE_PER_USER: authConfig.SESSIONS_SINGLE_PER_USER || false, + PASSWORD_MIN_LENGTH: authConfig.PASSWORD_MIN_LENGTH || 6, + PASSWORD_REQUIRED_CHARACTERS: + authConfig.PASSWORD_REQUIRED_CHARACTERS || NO_REQUIRED_CHARACTERS, + PASSWORD_HIBP_ENABLED: authConfig.PASSWORD_HIBP_ENABLED || false, + }) + } + }, [authConfig, isUpdatingProtection]) + + const onSubmitProtection = (values: any) => { + setIsUpdatingProtection(true) - const onSubmit = (values: any, { resetForm }: any) => { const payload = { ...values } payload.DISABLE_SIGNUP = !values.DISABLE_SIGNUP // The backend uses empty string to represent no required characters in the password @@ -97,11 +130,12 @@ const ProtectionAuthSettingsForm = () => { { projectRef: projectRef!, config: payload }, { onError: (error) => { - toast.error(`Failed to update settings: ${error?.message}`) + toast.error(`Failed to update settings: ${error?.message}`) + setIsUpdatingProtection(false) }, onSuccess: () => { - toast.success(`Successfully updated settings`) - resetForm({ values: values, initialValues: values }) + toast.success('Successfully updated settings') + setIsUpdatingProtection(false) }, } ) @@ -122,106 +156,122 @@ const ProtectionAuthSettingsForm = () => { } return ( -
- + + Bot and Abuse Protection -
- {({ handleReset, resetForm, values, initialValues, setFieldValue }: any) => { - const hasChanges = JSON.stringify(values) !== JSON.stringify(initialValues) - // Form is reset once remote data is loaded in store - // eslint-disable-next-line react-hooks/rules-of-hooks - useEffect(() => { - if (isSuccess) resetForm({ values: INITIAL_VALUES, initialValues: INITIAL_VALUES }) - }, [isSuccess]) + + + + + ( + + + + + + )} + /> + - return ( - <> - - -
- } - > - Bot and Abuse Protection}> - - - {values.SECURITY_CAPTCHA_ENABLED && ( - <> - - : } - type="default" - onClick={() => setHidden(!hidden)} - /> - } - /> - + {protectionForm.watch('SECURITY_CAPTCHA_ENABLED') && ( + <> + + ( + + + + + + + + hCaptcha + + Turnstile by Cloudflare + + + + + )} - - - - - ) - }} - - + /> + + + + ( + + +
+ setHidden(!hidden)} + icon={hidden ? : } + /> + } + > + + +
+ + + )} + /> + + + )} + + + {protectionForm.formState.isDirty && ( + + )} + + + + + + ) } diff --git a/apps/studio/pages/project/[ref]/auth/advanced.tsx b/apps/studio/pages/project/[ref]/auth/advanced.tsx index 5086974932a..f6a0ef0340f 100644 --- a/apps/studio/pages/project/[ref]/auth/advanced.tsx +++ b/apps/studio/pages/project/[ref]/auth/advanced.tsx @@ -1,44 +1,56 @@ import { PermissionAction } from '@supabase/shared-types/out/constants' +import { ReactNode } from 'react' +import { useParams } from 'common' import { AdvancedAuthSettingsForm } from 'components/interfaces/Auth/AdvancedAuthSettingsForm' import AuthLayout from 'components/layouts/AuthLayout/AuthLayout' import DefaultLayout from 'components/layouts/DefaultLayout' -import { ScaffoldContainer, ScaffoldHeader, ScaffoldTitle } from 'components/layouts/Scaffold' +import { PageLayout } from 'components/layouts/PageLayout/PageLayout' +import { ScaffoldContainer } from 'components/layouts/Scaffold' import NoPermission from 'components/ui/NoPermission' import { GenericSkeletonLoader } from 'components/ui/ShimmeringLoader' import { useCheckPermissions, usePermissionsLoaded } from 'hooks/misc/useCheckPermissions' import type { NextPageWithLayout } from 'types' -const PageLayout: NextPageWithLayout = () => { - const isPermissionsLoaded = usePermissionsLoaded() - // TODO: check if these permissions cover third party auth as well - const canReadAuthSettings = useCheckPermissions(PermissionAction.READ, 'custom_config_gotrue') - - return ( - <> - - - Advanced - - - - {!isPermissionsLoaded ? ( - - ) : !canReadAuthSettings ? ( - - ) : ( - - )} - - - ) +interface AdvancedLayoutProps { + children: ReactNode } -PageLayout.getLayout = (page) => { +export const AdvancedLayout = ({ children }: AdvancedLayoutProps) => { + const { ref } = useParams() + return ( - {page} + + + {children} + + ) } -export default PageLayout + +const AdvancedPage: NextPageWithLayout = () => { + const isPermissionsLoaded = usePermissionsLoaded() + const canReadAuthSettings = useCheckPermissions(PermissionAction.READ, 'custom_config_gotrue') + + if (isPermissionsLoaded && !canReadAuthSettings) { + return + } + + return ( + + {!isPermissionsLoaded ? ( +
+ +
+ ) : ( + + )} + + ) +} + +AdvancedPage.getLayout = (page) => {page} + +export default AdvancedPage diff --git a/apps/studio/pages/project/[ref]/auth/hooks.tsx b/apps/studio/pages/project/[ref]/auth/hooks.tsx index e939b807163..e3725985bf4 100644 --- a/apps/studio/pages/project/[ref]/auth/hooks.tsx +++ b/apps/studio/pages/project/[ref]/auth/hooks.tsx @@ -1,48 +1,49 @@ import { PermissionAction } from '@supabase/shared-types/out/constants' +import { ReactNode } from 'react' import { HooksListing } from 'components/interfaces/Auth/Hooks/HooksListing' import AuthLayout from 'components/layouts/AuthLayout/AuthLayout' -import { - ScaffoldHeader, - ScaffoldContainer, - ScaffoldTitle, - ScaffoldDescription, -} from 'components/layouts/Scaffold' +import DefaultLayout from 'components/layouts/DefaultLayout' +import { PageLayout } from 'components/layouts/PageLayout/PageLayout' +import { ScaffoldContainer } from 'components/layouts/Scaffold' import NoPermission from 'components/ui/NoPermission' import { useCheckPermissions, usePermissionsLoaded } from 'hooks/misc/useCheckPermissions' import type { NextPageWithLayout } from 'types' -import DefaultLayout from 'components/layouts/DefaultLayout' + +interface HooksLayoutProps { + children: ReactNode +} + +export const HooksLayout = ({ children }: HooksLayoutProps) => { + return ( + + + + {children} + + + + ) +} + const Hooks: NextPageWithLayout = () => { const canReadAuthSettings = useCheckPermissions(PermissionAction.READ, 'custom_config_gotrue') const isPermissionsLoaded = usePermissionsLoaded() if (isPermissionsLoaded && !canReadAuthSettings) { return - } else { - return ( -
- - - Auth Hooks - - Use Postgres functions or HTTP endpoints to customize the behavior of Supabase Auth to - meet your needs - - - - - - - -
- ) } + + return ( + + + + ) } -Hooks.getLayout = (page) => ( - - {page} - -) +Hooks.getLayout = (page) => {page} export default Hooks diff --git a/apps/studio/pages/project/[ref]/auth/protection.tsx b/apps/studio/pages/project/[ref]/auth/protection.tsx index 6f7bbddef9d..e4dea43e4c8 100644 --- a/apps/studio/pages/project/[ref]/auth/protection.tsx +++ b/apps/studio/pages/project/[ref]/auth/protection.tsx @@ -1,45 +1,59 @@ import { PermissionAction } from '@supabase/shared-types/out/constants' +import { ReactNode } from 'react' -import { - AuthProvidersForm, - ProtectionAuthSettingsForm, - ThirdPartyAuthForm, -} from 'components/interfaces/Auth' +import { useParams } from 'common' +import { ProtectionAuthSettingsForm } from 'components/interfaces/Auth' import AuthLayout from 'components/layouts/AuthLayout/AuthLayout' import DefaultLayout from 'components/layouts/DefaultLayout' -import { ScaffoldHeader, ScaffoldContainer, ScaffoldTitle } from 'components/layouts/Scaffold' +import { PageLayout } from 'components/layouts/PageLayout/PageLayout' +import { ScaffoldContainer } from 'components/layouts/Scaffold' import NoPermission from 'components/ui/NoPermission' +import { GenericSkeletonLoader } from 'components/ui/ShimmeringLoader' import { useCheckPermissions, usePermissionsLoaded } from 'hooks/misc/useCheckPermissions' import type { NextPageWithLayout } from 'types' -const PageLayout: NextPageWithLayout = () => { - const canReadAuthSettings = useCheckPermissions(PermissionAction.READ, 'custom_config_gotrue') - const isPermissionsLoaded = usePermissionsLoaded() - - if (isPermissionsLoaded && !canReadAuthSettings) { - return - } else { - return ( -
- - - Attack Protection - - - - - - -
- ) - } +interface ProtectionLayoutProps { + children: ReactNode } -PageLayout.getLayout = (page) => { +export const ProtectionLayout = ({ children }: ProtectionLayoutProps) => { + const { ref } = useParams() + return ( - {page} + + + {children} + + ) } -export default PageLayout + +const ProtectionPage: NextPageWithLayout = () => { + const isPermissionsLoaded = usePermissionsLoaded() + const canReadAuthSettings = useCheckPermissions(PermissionAction.READ, 'custom_config_gotrue') + + if (isPermissionsLoaded && !canReadAuthSettings) { + return + } + + return ( + + {!isPermissionsLoaded ? ( +
+ +
+ ) : ( + + )} + + ) +} + +ProtectionPage.getLayout = (page) => {page} + +export default ProtectionPage diff --git a/packages/ui-patterns/form/Layout/FormLayout.tsx b/packages/ui-patterns/form/Layout/FormLayout.tsx index f1940a90e6b..f8333c23bc3 100644 --- a/packages/ui-patterns/form/Layout/FormLayout.tsx +++ b/packages/ui-patterns/form/Layout/FormLayout.tsx @@ -45,7 +45,7 @@ const ContainerVariants = cva('relative grid gap-10', { horizontal: 'flex flex-col gap-2 md:grid md:grid-cols-12', vertical: 'flex flex-col gap-3', flex: 'flex flex-row gap-3', - 'flex-row-reverse': 'flex flex-row gap-3 flex-row-reverse justify-between', + 'flex-row-reverse': 'flex flex-row gap-6 flex-row-reverse justify-between', }, flex: { true: '', @@ -233,7 +233,7 @@ const FlexContainer = cva('', { }, { layout: 'flex-row-reverse', - className: 'flex flex-col justify-center items-end', + className: 'flex flex-col justify-center items-end shrink-0', }, ], }) diff --git a/packages/ui/index.tsx b/packages/ui/index.tsx index 37bf296a2ae..ef837cb4dc2 100644 --- a/packages/ui/index.tsx +++ b/packages/ui/index.tsx @@ -58,6 +58,8 @@ export * from './src/components/Upload' export * from './src/components/Form' export * from './src/components/ExpandingTextArea' +export * from './src/components/PrePostTab' + // layout export * from './src/components/LoadingLine' diff --git a/packages/ui/src/components/PrePostTab/PrePostTab.tsx b/packages/ui/src/components/PrePostTab/PrePostTab.tsx new file mode 100644 index 00000000000..be2180673f6 --- /dev/null +++ b/packages/ui/src/components/PrePostTab/PrePostTab.tsx @@ -0,0 +1,36 @@ +import { forwardRef, ReactNode, PropsWithChildren, HTMLAttributes } from 'react' +import { cn } from '../../lib/utils' + +export interface PrePostTabProps extends HTMLAttributes { + preTab?: ReactNode | string + postTab?: ReactNode | string +} + +export const PrePostTab = forwardRef>( + ({ preTab, postTab, children, className, ...props }, ref) => { + return ( +
+ {preTab && ( +
+ {preTab} +
+ )} +
+ {children} +
+ {postTab && ( +
+ {postTab} +
+ )} +
+ ) + } +) diff --git a/packages/ui/src/components/PrePostTab/index.tsx b/packages/ui/src/components/PrePostTab/index.tsx new file mode 100644 index 00000000000..89a9935b84a --- /dev/null +++ b/packages/ui/src/components/PrePostTab/index.tsx @@ -0,0 +1,2 @@ +export { PrePostTab } from './PrePostTab' +export type { PrePostTabProps } from './PrePostTab' From 419252c1020ea63e415b79e08811121da4e60267 Mon Sep 17 00:00:00 2001 From: Saxon Fletcher Date: Tue, 4 Mar 2025 10:22:45 +1000 Subject: [PATCH 16/50] Updating authentication email pages (#33958) * init PrePostTab component * init * support auto fixing rounded of inputs/select/textarea * remove form item layout prepost * Update FormLayout.tsx * Update FormLayout.tsx * Update FormLayout.tsx * form layout and advanced * Update advanced.tsx * protection and hooks * auth emails * preview styles * fix * parse --------- Co-authored-by: Jonathan Summers-Muir --- .../Auth/EmailTemplates/EmailTemplates.tsx | 17 +- .../Auth/EmailTemplates/SpamValidation.tsx | 50 +- .../Auth/EmailTemplates/TemplateEditor.tsx | 387 ++++++----- .../interfaces/Auth/SmtpForm/SmtpForm.tsx | 615 +++++++++++------- .../layouts/AuthLayout/AuthEmailsLayout.tsx | 39 ++ apps/studio/pages/project/[ref]/auth/smtp.tsx | 69 +- .../pages/project/[ref]/auth/templates.tsx | 70 +- 7 files changed, 685 insertions(+), 562 deletions(-) create mode 100644 apps/studio/components/layouts/AuthLayout/AuthEmailsLayout.tsx diff --git a/apps/studio/components/interfaces/Auth/EmailTemplates/EmailTemplates.tsx b/apps/studio/components/interfaces/Auth/EmailTemplates/EmailTemplates.tsx index e67cb1ca492..0fb588f4594 100644 --- a/apps/studio/components/interfaces/Auth/EmailTemplates/EmailTemplates.tsx +++ b/apps/studio/components/interfaces/Auth/EmailTemplates/EmailTemplates.tsx @@ -6,6 +6,8 @@ import { FormPanel } from 'components/ui/Forms/FormPanel' import { GenericSkeletonLoader } from 'components/ui/ShimmeringLoader' import { useAuthConfigQuery } from 'data/auth/auth-config-query' import { + Card, + CardContent, ScrollArea, Tabs_Shadcn_, TabsContent_Shadcn_, @@ -37,20 +39,20 @@ const EmailTemplates = () => { )} {isLoading && ( -
+
)} {isSuccess && ( - <> +
{builtInSMTP ? (
) : null} - + - + {TEMPLATES_SCHEMAS.map((template) => { return ( @@ -59,18 +61,17 @@ const EmailTemplates = () => { ) })} - {TEMPLATES_SCHEMAS.map((template) => { const panelId = template.title.trim().replace(/\s+/g, '-') return ( - + ) })} - - + +
)}
) diff --git a/apps/studio/components/interfaces/Auth/EmailTemplates/SpamValidation.tsx b/apps/studio/components/interfaces/Auth/EmailTemplates/SpamValidation.tsx index 648a3f075fe..3cd49de2d3c 100644 --- a/apps/studio/components/interfaces/Auth/EmailTemplates/SpamValidation.tsx +++ b/apps/studio/components/interfaces/Auth/EmailTemplates/SpamValidation.tsx @@ -1,17 +1,7 @@ import { Markdown } from 'components/interfaces/Markdown' -import InformationBox from 'components/ui/InformationBox' import { ValidateSpamResponse } from 'data/auth/validate-spam-mutation' -import { - cn, - Separator, - Table, - TableBody, - TableCell, - TableHead, - TableHeader, - TableRow, - WarningIcon, -} from 'ui' +import { Check, MailWarning } from 'lucide-react' +import { Separator, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from 'ui' interface SpamValidationProps { validationResult?: ValidateSpamResponse @@ -26,23 +16,23 @@ export const SpamValidation = ({ validationResult }: SpamValidationProps) => { const hasSpamWarning = spamRules.length > 0 return ( - } - title={ - hasSpamWarning - ? 'Email has a high probability of being marked as spam and deliverability may be affected' - : 'Email content is unlikely to be marked as spam' - } - description={ - hasSpamWarning ? ( +
+
+ {hasSpamWarning ? ( + + ) : ( + + )} +
+
+
+ {hasSpamWarning + ? 'Email has a high probability of being marked as spam - review issues below to improve deliverability.' + : 'Email content is unlikely to be marked as spam'} +
+ {hasSpamWarning && ( <>
-

- {hasSpamWarning - ? ` Rectify the following issues to improve your email's deliverability in order of priority:` - : ` Address the following issues to improve your email's deliverability:`} -

@@ -68,8 +58,8 @@ export const SpamValidation = ({ validationResult }: SpamValidationProps) => { content="Spam validation is powered by [SpamAssassin](https://spamassassin.apache.org/doc.html). Full list of all available warnings can be found [here](https://gist.github.com/ychaouche/a2faff159c2a1fea16019156972c7f8b)." /> - ) : null - } - /> + )} + + ) } diff --git a/apps/studio/components/interfaces/Auth/EmailTemplates/TemplateEditor.tsx b/apps/studio/components/interfaces/Auth/EmailTemplates/TemplateEditor.tsx index 5e1d5738d1a..34d72fd0e02 100644 --- a/apps/studio/components/interfaces/Auth/EmailTemplates/TemplateEditor.tsx +++ b/apps/studio/components/interfaces/Auth/EmailTemplates/TemplateEditor.tsx @@ -1,28 +1,39 @@ import { PermissionAction } from '@supabase/shared-types/out/constants' import { Code, Monitor } from 'lucide-react' -import { useEffect, useMemo, useState } from 'react' +import { editor } from 'monaco-editor' +import { useEffect, useMemo, useRef, useState } from 'react' import ReactMarkdown from 'react-markdown' import { toast } from 'sonner' +import { useForm } from 'react-hook-form' import { useParams } from 'common' import CodeEditor from 'components/ui/CodeEditor/CodeEditor' -import { FormActions } from 'components/ui/Forms/FormActions' -import { FormSection, FormSectionContent, FormSectionLabel } from 'components/ui/Forms/FormSection' -import InformationBox from 'components/ui/InformationBox' import { useAuthConfigQuery } from 'data/auth/auth-config-query' import { useAuthConfigUpdateMutation } from 'data/auth/auth-config-update-mutation' import { useValidateSpamMutation, ValidateSpamResponse } from 'data/auth/validate-spam-mutation' import { useCheckPermissions } from 'hooks/misc/useCheckPermissions' import type { FormSchema } from 'types' import { - Form, - Input, + Badge, + Button, + Card, + CardContent, + CardFooter, + Form_Shadcn_, + FormControl_Shadcn_, + FormField_Shadcn_, + Input_Shadcn_, + Label_Shadcn_, Tabs_Shadcn_, TabsContent_Shadcn_, TabsList_Shadcn_, TabsTrigger_Shadcn_, + Tooltip, + TooltipContent, + TooltipTrigger, } from 'ui' import { Admonition } from 'ui-patterns' +import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout' import { SpamValidation } from './SpamValidation' interface TemplateEditorProps { @@ -33,6 +44,9 @@ const TemplateEditor = ({ template }: TemplateEditorProps) => { const { ref: projectRef } = useParams() const canUpdateConfig = useCheckPermissions(PermissionAction.UPDATE, 'custom_config_gotrue') + // Add a ref to the code editor + const editorRef = useRef() + // [Joshen] Error state is handled in the parent const { data: authConfig, isSuccess } = useAuthConfigQuery({ projectRef }) @@ -49,15 +63,6 @@ const TemplateEditor = ({ template }: TemplateEditorProps) => { const { id, properties } = template - const formId = `auth-config-email-templates-${id}` - const INITIAL_VALUES = useMemo(() => { - const result: { [x: string]: string } = {} - Object.keys(properties).forEach((key) => { - result[key] = ((authConfig && authConfig[key as keyof typeof authConfig]) ?? '') as string - }) - return result - }, [authConfig, properties]) - const messageSlug = `MAILER_TEMPLATES_${id}_CONTENT` as keyof typeof authConfig const messageProperty = properties[messageSlug] const builtInSMTP = @@ -74,7 +79,33 @@ const TemplateEditor = ({ template }: TemplateEditorProps) => { const spamRules = (validationResult?.rules ?? []).filter((rule) => rule.score > 0) const preventSaveFromSpamCheck = builtInSMTP && spamRules.length > 0 - const onSubmit = (values: any, { resetForm }: any) => { + // Create form values + const INITIAL_VALUES = useMemo(() => { + const result: { [x: string]: string } = {} + Object.keys(properties).forEach((key) => { + result[key] = ((authConfig && authConfig[key as keyof typeof authConfig]) ?? '') as string + }) + return result + }, [authConfig, properties]) + + // Setup React Hook Form + const form = useForm({ + defaultValues: INITIAL_VALUES, + }) + + // Update form values when authConfig changes + useEffect(() => { + if (authConfig) { + const values: { [key: string]: string } = {} + Object.keys(properties).forEach((key) => { + values[key] = ((authConfig && authConfig[key as keyof typeof authConfig]) ?? '') as string + }) + form.reset(values) + setBodyValue((authConfig && authConfig[messageSlug]) ?? '') + } + }, [authConfig, properties, messageSlug, form]) + + const onSubmit = (values: any) => { if (!projectRef) return console.error('Project ref is required') setIsSavingTemplate(true) @@ -112,10 +143,6 @@ const TemplateEditor = ({ template }: TemplateEditorProps) => { onSuccess: () => { setIsSavingTemplate(false) toast.success('Successfully updated settings') - resetForm({ - values: values, - initialValues: values, - }) setHasUnsavedChanges(false) // Reset the unsaved changes state }, } @@ -157,140 +184,202 @@ const TemplateEditor = ({ template }: TemplateEditorProps) => { // eslint-disable-next-line react-hooks/exhaustive-deps }, [id]) - return ( -
- {({ resetForm, values, initialValues }: any) => { - const message = (authConfig && authConfig[messageSlug]) ?? '' - const hasChanges = - JSON.stringify(values) !== JSON.stringify(initialValues) || message !== bodyValue + // Single useMemo hook to parse and prepare message variables + const messageVariables = useMemo(() => { + if (!messageProperty?.description) return [] - return ( + // Parse bullet point format: - `{{ .Variable }}` : Description + const lines = messageProperty.description.split('\n') + const variables: { variable: string; description: string }[] = [] + + for (const line of lines) { + // Match lines that start with a bullet point followed by a variable in the format {{ .Variable }} + // Handle variations in formatting (with or without backticks, different spacing) + const match = line.match(/-\s*`?({{\s*\.\w+\s*}})`?\s*(?::|-)?\s*(.+)/) + if (match && match[1] && match[2]) { + variables.push({ + variable: match[1].replace(/`/g, '').trim(), + description: match[2].trim(), + }) + } + } + + return variables + }, [messageProperty?.description]) + + // Check if form values have changed + const formValues = form.watch() + const hasFormChanges = JSON.stringify(formValues) !== JSON.stringify(INITIAL_VALUES) + const hasChanges = hasFormChanges || ((authConfig && authConfig[messageSlug]) ?? '') !== bodyValue + + // Function to insert text at cursor position + const insertTextAtCursor = (text: string) => { + if (!editorRef.current) return + + const editor = editorRef.current + const selection = editor.getSelection() + + if (selection) { + const range = { + startLineNumber: selection.startLineNumber, + startColumn: selection.startColumn, + endLineNumber: selection.endLineNumber, + endColumn: selection.endColumn, + } + + editor.executeEdits('insert-variable', [ + { + range, + text, + forceMoveMarkers: true, + }, + ]) + + // Focus the editor after insertion + editor.focus() + } + } + + return ( + + + + {Object.keys(properties).map((x: string) => { + const property = properties[x] + if (property.type === 'string' && x !== messageSlug) { + return ( + ( + + {property.description} + + ) : null + } + labelOptional={ + property.descriptionOptional ? ( + + {property.descriptionOptional} + + ) : null + } + > + + + + + )} + /> + ) + } + return null + })} + + + {messageProperty && ( <> - - - {Object.keys(properties).map((x: string) => { - const property = properties[x] - if (property.type === 'string') { - return ( -
- - - {property.description} - - ) : null - } - labelOptional={ - property.descriptionOptional ? ( - - {property.descriptionOptional} - - ) : null - } - disabled={!canUpdateConfig} - /> -
- ) - } - })} - - - - - {messageProperty && ( - <> -
- - {messageProperty.title} - - {messageProperty.description} - ) - } - /> -
- - - - - Source - - - - Preview - - - - { - setBodyValue(e ?? '') - if (bodyValue !== e) setHasUnsavedChanges(true) - }} - options={{ wordWrap: 'on', contextmenu: false }} - value={bodyValue} - /> - - - - -